gopls/internal/mcp/rename_symbol.go

// Copyright 2025 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package mcp

import (
	"bytes"
	"context"
	"fmt"
	"io"

	"github.com/modelcontextprotocol/go-sdk/mcp"
	"golang.org/x/tools/gopls/internal/cache"
	"golang.org/x/tools/gopls/internal/file"
	"golang.org/x/tools/gopls/internal/golang"
	"golang.org/x/tools/gopls/internal/protocol"
)

type renameSymbolParams struct {
	File    string `json:"file" jsonschema:"the absolute path to the file containing the symbol"`
	Symbol  string `json:"symbol" jsonschema:"the symbol or qualified symbol"`
	NewName string `json:"new_name" jsonschema:"the new name for the symbol"`
}

func (h *handler) renameSymbolHandler(ctx context.Context, req *mcp.CallToolRequest, params renameSymbolParams) (*mcp.CallToolResult, any, error) {
	countGoRenameSymbolMCP.Inc()
	fh, snapshot, release, err := h.fileOf(ctx, params.File)
	if err != nil {
		return nil, nil, err
	}
	defer release()

	if snapshot.FileKind(fh) != file.Go {
		return nil, nil, fmt.Errorf("can't rename symbols in non-Go files")
	}
	loc, err := symbolLocation(ctx, snapshot, fh.URI(), params.Symbol)
	if err != nil {
		return nil, nil, err
	}
	changes, err := golang.Rename(ctx, snapshot, fh, loc.Range.Start, params.NewName)
	if err != nil {
		return nil, nil, err
	}
	var buf bytes.Buffer
	if err := formatRenameChanges(ctx, snapshot, &buf, changes); err != nil {
		return nil, nil, err
	}
	return textResult(buf.String()), nil, nil
}

// formatRenameChanges converts the list of DocumentChange to a unified diff and writes them to the specified buffer.
func formatRenameChanges(ctx context.Context, snapshot *cache.Snapshot, w io.Writer, changes []protocol.DocumentChange) error {
	diff, err := toUnifiedDiff(ctx, snapshot, changes)
	if err != nil {
		return err
	}
	fmt.Fprintf(w, "The following changes are necessary to rename the symbol:\n%s\n", diff)
	return nil
}