Get Symbol Info

get-symbol-info · Query · CorePlugin · Code discovery and navigation

Returns detailed metadata for a resolved symbol.

Availability: Built in and published in every operational mode.

Generated from Roslyn Workbench MCP 1.1.0 (1.1.0).

Behaviour annotations

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

Request

Property	Type	Required	Description
`symbol`	`object`	Yes	The symbol selector.
`includeDocumentation`	`boolean`	No	Whether XML documentation should be included.
`parametersLimit`	`integer \| null`	No	Maximum number of parameters to return.
`declarationsLimit`	`integer \| null`	No	Maximum number of declarations to return.
`expectedSnapshot`	`object \| null`	No	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 \| null`	Yes	Tool-specific result payload.
`snapshot`	`object`	Yes	Exact immutable workspace snapshot associated with the result, when available.
`warnings`	`array`	No	Non-fatal warnings the agent should consider.

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.
`diagnostics`	`array`	No	Diagnostics that explain the failed invocation.
`warnings`	`array`	No	Non-fatal warnings the agent should consider.

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.
`diagnostics`	`object`	Yes	Diagnostics that explain the failed invocation.
`reporting`	`object`	No	Error-reporting workflow available for an unhandled failure.

Bounded collections and continuation

These response locations publish returned items with explicit bounds and continuation state:

$/oneOf/0/properties/data/properties/parameters
$/oneOf/0/properties/data/properties/declarations

Continuations and required actions

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

$/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": "Zero-based UTF-16 offset.",
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 2147483647
                    },
                    "length": {
                      "description": "UTF-16 code-unit length.",
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 2147483647
                    }
                  }
                }
              },
              "required": [
                "document",
                "range"
              ]