Rename Symbol

rename-symbol · Mutation · CorePlugin · Code mutation

Stages a symbol rename across the effective solution.

Availability: Built in and published by default.

Generated from Roslyn Workbench MCP 0.1.0 (0.1.0).

Behaviour annotations

Annotation	Value
`destructiveHint`	`true`
`idempotentHint`	`false`
`openWorldHint`	`false`
`readOnlyHint`	`false`
`title`	`"Rename Symbol"`

Request

Property	Type	Required	Description
`symbol`	`object`	Yes	The symbol selector.
`newName`	`string`	Yes	The new symbol name.
`renameOverloads`	`boolean`	No	Whether overloads should also be renamed.
`renameInStrings`	`boolean`	No	Whether matching identifiers in string literals should also be renamed.
`renameInComments`	`boolean`	No	Whether matching identifiers in comments should also be renamed.
`renameFile`	`boolean`	No	Whether the containing file should be renamed for type symbols.
`expectedSnapshot`	`object`	Yes	Echo the snapshot returned with the data or transaction state used to construct this request.
`workspace`	`object \| null`	No	Provide workspaceId, alias, path, or any combination.

Response

Success response

Property	Type	Required	Description
`ok`	`boolean constant (true)`	Yes	Whether the tool invocation succeeded.
`data`	`object`	Yes	Tool-specific result payload.
`snapshot`	`object`	Yes	Exact immutable workspace snapshot associated with the result, when available.

Error response

Property	Type	Required	Description
`ok`	`boolean constant (false)`	Yes	Whether the tool invocation succeeded.
`error`	`object`	Yes	Structured error details when the invocation failed.
`continuation`	`oneOf`	No	Action the agent should take before retrying or continuing.

Continuations and required actions

A non-success response may include a structured continuation at the following schema location. Follow its tool call or user-action instruction instead of guessing how to retry:

$/oneOf/1/properties/continuation

Complete input schema

{
  "type": "object",
  "properties": {
    "symbol": {
      "description": "The symbol selector.",
      "type": "object",
      "properties": {
        "project": {
          "description": "Disambiguates symbols with matching identities.",
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "projectId": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "path": {
              "description": "Workspace-relative path.",
              "type": "string"
            },
            "targetFramework": {
              "type": "string"
            }
          }
        },
        "location": {
          "description": "Provide exactly one of span or selection.",
          "type": "object",
          "properties": {
            "span": {
              "type": "object",
              "properties": {
                "document": {
                  "description": "Provide exactly one of path or documentId.",
                  "type": "object",
                  "properties": {
                    "project": {
                      "description": "Disambiguates documents with matching paths or IDs.",
                      "type": [
                        "object",
                        "null"
                      ],
                      "properties": {
                        "projectId": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "path": {
                          "description": "Workspace-relative path.",
                          "type": "string"
                        },
                        "targetFramework": {
                          "type": "string"
                        }
                      }
                    },
                    "path": {
                      "description": "Workspace-relative path.",
                      "type": "string"
                    },
                    "documentId": {
                      "description": "Workspace-local document ID.",
                      "type": "string"
                    }
                  }
                },
                "range": {
                  "description": "Zero-based UTF-16 range.",
                  "type": "object",
                  "properties": {
                    "start": {
                      "description":