Skip to content

Get Symbol Dependencies

get-symbol-dependencies · Query · CorePlugin · Code analysis

Returns the direct symbols used by a resolved symbol.

Availability: Built in and published in every operational mode.

Generated from Roslyn Workbench MCP 1.0.0-rc.1 (1.0.0-rc.1).

Behaviour annotations

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

Request

Property Type Required Description
symbol object Yes The symbol selector.
includeAssemblies boolean No Whether containing assembly names should be included with each dependency.
dependenciesLimit integer | null No Maximum number of results 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/dependencies

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"
              ]
            },
            "selection": {
              "type": "object",
              "properties": {
                "document": {
                  "description": "Provide exactly one of path or documentId.",
                  "type": "object",
                  "properties": {
                    "project": {
                      "description": "Disambiguates documents with matching paths or IDs.",
                      "$ref": "#/properties/symbol/properties/location/properties/span/properties/document/properties/project"
                    },
                    "path": {
                      "description": "Workspace-relative path.",
                      "type": "string"
                    },
                    "documentId": {
                      "description": "Workspace-local document ID.",
                      "type": "string"
                    }
                  }
                },
                "selectedText": {
                  "type": "string",
                  "minLength": 1
                },
                "contextBefore": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "contextAfter": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "document",
                "selectedText"
              ]
            }
          }
        },
        "documentationCommentId": {
          "type": "string"
        }
      }
    },
    "includeAssemblies": {
      "description": "Whether containing assembly names should be included with each dependency.",
      "type": "boolean"
    },
    "dependenciesLimit": {
      "description": "Maximum number of results to return.",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "maximum": 2147483647,
      "default": 100
    },
    "expectedSnapshot": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "workspaceId": {
          "type": "string",
          "format": "uuid"
        },
        "workspaceEpoch": {
          "type": "integer"
        },
        "snapshotId": {
          "type": "string",
          "format": "uuid"
        },
        "transactionRevision": {
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "required": [
        "workspaceId",
        "workspaceEpoch",
        "snapshotId",
        "transactionRevision"
      ],
      "description": "Echo the snapshot returned with the data or transaction state used to construct this request."
    },
    "workspace": {
      "description": "Provide workspaceId, alias, path, or any combination.",
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "workspaceId": {
          "type": "string",
          "format": "uuid"
        },
        "alias": {
          "type": "string"
        },
        "path": {
          "description": "Absolute workspace path.",
          "type": "string"
        }
      }
    }
  },
  "required": [
    "symbol"
  ]
}
Complete output schema
{
  "type": "object",
  "oneOf": [
    {
      "type": "object",
      "required": [
        "ok",
        "data",
        "snapshot"
      ],
      "properties": {
        "ok": {
          "const": true,
          "description": "Whether the tool invocation succeeded."
        },
        "data": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "symbol": {
              "description": "The queried symbol.",
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "displayName": {
                  "description": "The display name of the symbol.",
                  "type": "string"
                },
                "kind": {
                  "description": "The symbol kind.",
                  "type": "string"
                },
                "documentationCommentId": {
                  "description": "The documentation comment identifier, when available.",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "location": {
                  "description": "The optional source location of the symbol.",
                  "type": [
                    "object",