Skip to main content
Glama

Get Symbol Info

get-symbol-info
Read-onlyIdempotent

Inspect a resolved C# symbol to retrieve accessibility, modifiers, associated type, declaration locations, and method parameters or return type.

Instructions

Inspects one resolved symbol, returning accessibility, modifiers, associated type and source declaration locations, plus method parameters and return type when applicable. Use this after search-symbols or resolve-symbol to understand a chosen declaration; use find-references for its usages or get-symbol-members to enumerate type members. XML documentation is opt-in through includeDocumentation. Defaults to 32 declarations and 64 method parameters, bounded independently; check declarations.hasMore and parameters.hasMore when present. Metadata-only symbols may have no source declarations.

Input Schema

NameRequiredDescriptionDefault
symbolYesThe symbol selector.
workspaceNoProvide workspaceId, alias, path, or any combination.
parametersLimitNoMaximum number of parameters to return.
expectedSnapshotNoEcho the snapshot returned with the data or transaction state used to construct this request.
declarationsLimitNoMaximum number of declarations to return.
includeDocumentationNoWhether XML documentation should be included.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv1.0.5
    • addedInput schema / $defs
      Added value: +{
      +  "document": {
      +    "properties": {
      +      "documentId": {
      +        "description": "Workspace-local document ID.",
      +        "type": "string"
      +      },
      +      "path": {
      +        "description": "Workspace-relative path.",
      +        "type": "string"
      +      },
      +      "project": {
      +        "$ref": "#/$defs/project",
      +        "description": "Disambiguates documents with matching paths or IDs."
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "project": {
      +    "properties": {
      +      "name": {
      +        "type": "string"
      +      },
      +      "path": {
      +        "description": "Workspace-relative path.",
      +        "type": "string"
      +      },
      +      "projectId": {
      +        "type": "string"
      +      },
      +      "targetFramework": {
      +        "type": "string"
      +      }
      +    },
      +    "type": [
      +      "object",
      +      "null"
      +    ]
      +  }
      +}
    • addedInput schema / properties / symbol / properties / location / properties / selection / properties / document / $ref
      Added value: +"#/$defs/document"
    • removedInput schema / properties / symbol / properties / location / properties / selection / properties / document / properties
      Removed value: -{
      -  "documentId": {
      -    "description": "Workspace-local document ID.",
      -    "type": "string"
      -  },
      -  "path": {
      -    "description": "Workspace-relative path.",
      -    "type": "string"
      -  },
      -  "project": {
      -    "$ref": "#/properties/symbol/properties/location/properties/span/properties/document/properties/project",
      -    "description": "Disambiguates documents with matching paths or IDs."
      -  }
      -}
    • removedInput schema / properties / symbol / properties / location / properties / selection / properties / document / type
      Removed value: -"object"
    • addedInput schema / properties / symbol / properties / location / properties / span / properties / document / $ref
      Added value: +"#/$defs/document"
    • removedInput schema / properties / symbol / properties / location / properties / span / properties / document / properties
      Removed value: -{
      -  "documentId": {
      -    "description": "Workspace-local document ID.",
      -    "type": "string"
      -  },
      -  "path": {
      -    "description": "Workspace-relative path.",
      -    "type": "string"
      -  },
      -  "project": {
      -    "description": "Disambiguates documents with matching paths or IDs.",
      -    "properties": {
      -      "name": {
      -        "type": "string"
      -      },
      -      "path": {
      -        "description": "Workspace-relative path.",
      -        "type": "string"
      -      },
      -      "projectId": {
      -        "type": "string"
      -      },
      -      "targetFramework": {
      -        "type": "string"
      -      }
      -    },
      -    "type": [
      -      "object",
      -      "null"
      -    ]
      -  }
      -}
    • removedInput schema / properties / symbol / properties / location / properties / span / properties / document / type
      Removed value: -"object"
    • addedInput schema / properties / symbol / properties / project / $ref
      Added value: +"#/$defs/project"
    • removedInput schema / properties / symbol / properties / project / properties
      Removed value: -{
      -  "name": {
      -    "type": "string"
      -  },
      -  "path": {
      -    "description": "Workspace-relative path.",
      -    "type": "string"
      -  },
      -  "projectId": {
      -    "type": "string"
      -  },
      -  "targetFramework": {
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / symbol / properties / project / type
      Removed value: -[
      -  "object",
      -  "null"
      -]
  2. Changed1 schema field changedv1.0.4
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$defs": {
      +    "warningInfo": {
      +      "properties": {
      +        "code": {
      +          "description": "The stable machine-readable warning code.",
      +          "type": "string"
      +        },
      +        "message": {
      +          "description": "The human-readable warning message.",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "code",
      +        "message"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "oneOf": [
      +    {
      +      "properties": {
      +        "data": {
      +          "description": "Tool-specific result payload.",
      +          "properties": {
      +            "accessibility": {
      +              "description": "The symbol accessibility.",
      +              "type": "string"
      +            },
      +            "declarations": {
      +              "description": "The source declarations for the symbol.",
      +              "properties": {
      +                "hasMore": {
      +                  "description": "Whether additional items were available beyond this page.",
      +                  "type": "boolean"
      +                },
      +                "items": {
      +                  "description": "Items returned in this page.",
      +                  "items": {
      +                    "properties": {
      +                      "column": {
      +                        "description": "The one-based column number.",
      +                        "type": "integer"
      +                      },
      +                      "document": {
      +                        "$ref": "#/properties/request/properties/value/properties/symbol/properties/location/properties/document",
      +                        "description": "The resolved document."
      +                      },
      +                      "line": {
      +                        "description": "The one-based line number.",
      +                        "type": "integer"
      +                      },
      +                      "selector": {
      +                        "$ref": "#/properties/request/properties/value/properties/symbol/properties/location/properties/selector",
      +                        "description": "The canonical selector that can resolve this source location again."
      +                      },
      +                      "snapshot": {
      +                        "$ref": "#/properties/request/properties/value/properties/symbol/properties/location/properties/snapshot",
      +                        "description": "The exact immutable workspace snapshot associated with this location."
      +                      },
      +                      "span": {
      +                        "$ref": "#/properties/request/properties/value/properties/symbol/properties/location/properties/span",
      +                        "description": "The resolved text span."
      +                      }
      +                    },
      +                    "required": [
      +                      "snapshot"
      +                    ],
      +                    "type": "object"
      +                  },
      +                  "type": [
      +                    "array",
      +                    "null"
      +                  ]
      +                },
      +                "totalCount": {
      +                  "description": "Complete result count, when available without additional expensive work.",
      +                  "type": [
      +                    "integer",
      +                    "null"
      +                  ]
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "documentation": {
      +              "description": "The XML documentation text, when requested.",
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "modifiers": {
      +              "description": "The symbol modifiers.",
      +              "items": {
      +                "type": "string"
      +              },
      +              "type": "array"
      +            },
      +            "parameters": {
      +              "description": "The callable parameter information, when applicable.",
      +              "properties": {
      +                "hasMore": {
      +                  "description": "Whether additional items were available beyond this page.",
      +                  "type": "boolean"
      +                },
      +                "items": {
      +                  "description": "Items returned in this page.",
      +                  "items": {
      +                    "properties": {
      +                      "defaultValue": {
      +                        "description": "The formatted default value, when available.",
      +                        "type": [
      +                          "string",
      +                          "null"
      +                        ]
      +                      },
      +                      "hasExplicitDefaultValue": {
      +                        "description": "Whether the parameter has an explicit default value.",
      +                        "type": "boolean"
      +                      },
      +                      "isOptional": {
      +                        "description": "Whether the parameter is optional.",
      +                        "type": "boolean"
      +                      },
      +                      "name": {
      +                        "description": "The parameter name.",
      +                        "type": "string"
      +                      },
      +                      "refKind": {
      +                        "description": "The parameter passing mode.",
      +                        "type": "string"
      +                      },
      +                      "type": {
      +                        "description": "The parameter type information.",
      +                        "properties": {
      +                          "displayName": {
      +                            "description": "The display name.",
      +                            "type": "string"
      +                          },
      +                          "documentationCommentId": {
      +                            "description": "The documentation-comment identifier, when available.",
      +                            "type": [
      +                              "string",
      +                              "null"
      +                            ]
      +                          },
      +                          "kind": {
      +                            "description": "The Roslyn type kind.",
      +                            "type": "string"
      +                          },
      +                          "nullableAnnotation": {
      +                            "description": "The nullable annotation.",
      +                            "type": [
      +                              "string",
      +                              "null"
      +                            ]
      +                          }
      +                        },
      +                        "required": [
      +                          "displayName",
      +                          "kind"
      +                        ],
      +                        "type": [
      +                          "object",
      +                          "null"
      +                        ]
      +                      }
      +                    },
      +                    "required": [
      +                      "name",
      +                      "refKind"
      +                    ],
      +                    "type": "object"
      +                  },
      +                  "type": [
      +                    "array",
      +                    "null"
      +                  ]
      +                },
      +                "totalCount": {
      +                  "description": "Complete result count, when available without additional expensive work.",
      +                  "type": [
      +                    "integer",
      +                    "null"
      +                  ]
      +                }
      +              },
      +              "type": [
      +                "object",
      +                "null"
      +              ]
      +            },
      +            "returnType": {
      +              "description": "The return type information, when applicable.",
      +              "properties": {
      +                "displayName": {
      +                  "description": "The display name.",
      +                  "type": "string"
      +                },
      +                "documentationCommentId": {
      +                  "description": "The documentation-comment identifier, when available.",
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "kind": {
      +                  "description": "The Roslyn type kind.",
      +                  "type": "string"
      +                },
      +                "nullableAnnotation": {
      +                  "description": "The nullable annotation.",
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                }
      +              },
      +              "required": [
      +                "displayName",
      +                "kind"
      +              ],
      +              "type": [
      +                "object",
      +                "null"
      +              ]
      +            },
      +            "symbol": {
      +              "description": "The resolved symbol.",
      +              "properties": {
      +                "displayName": {
      +                  "description": "The display name of the symbol.",
      +                  "type": "string"
      +                },
      +                "documentationCommentId": {
      +                  "description": "The documentation comment identifier, when available.",
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "kind": {
      +                  "description": "The symbol kind.",
      +                  "type": "string"
      +                },
      +                "location": {
      +                  "description": "The optional source location of the symbol.",
      +                  "properties": {
      +                    "column": {
      +                      "description": "The one-based column number.",
      +                      "type": "integer"
      +                    },
      +                    "document": {
      +                      "description": "The resolved document.",
      +                      "properties": {
      +                        "documentId": {
      +                          "description": "The document identifier.",
      +                          "type": "string"
      +                        },
      +                        "path": {
      +                          "description": "The normalized document path.",
      +                          "type": "string"
      +                        },
      +                        "projectId": {
      +                          "description": "The owning project identifier.",
      +                          "type": "string"
      +                        }
      +                      },
      +                      "required": [
      +                        "documentId",
      +                        "path",
      +                        "projectId"
      +                      ],
      +                      "type": [
      +                        "object",
      +                        "null"
      +                      ]
      +                    },
      +                    "line": {
      +                      "description": "The one-based line number.",
      +                      "type": "integer"
      +                    },
      +                    "selector": {
      +                      "description": "The canonical selector that can resolve this source location again.",
      +                      "properties": {
      +                        "span": {
      +                          "properties": {
      +                            "document": {
      +                              "description": "Provide exactly one of path or documentId.",
      +                              "properties": {
      +                                "documentId": {
      +                                  "description": "Workspace-local document ID.",
      +                                  "type": [
      +                                    "string",
      +                                    "null"
      +                                  ]
      +                                },
      +                                "path": {
      +                                  "description": "Workspace-relative path.",
      +                                  "type": [
      +                                    "string",
      +                                    "null"
      +                                  ]
      +                                },
      +                                "project": {
      +                                  "description": "Disambiguates documents with matching paths or IDs.",
      +                                  "properties": {
      +                                    "name": {
      +                                      "type": [
      +                                        "string",
      +                                        "null"
      +                                      ]
      +                                    },
      +                                    "path": {
      +                                      "description": "Workspace-relative path.",
      +                                      "type": [
      +                                        "string",
      +                                        "null"
      +                                      ]
      +                                    },
      +                                    "projectId": {
      +                                      "type": [
      +                                        "string",
      +                                        "null"
      +                                      ]
      +                                    },
      +                                    "targetFramework": {
      +                                      "type": [
      +                                        "string",
      +                                        "null"
      +                                      ]
      +                                    }
      +                                  },
      +                                  "type": [
      +                                    "object",
      +                                    "null"
      +                                  ]
      +                                }
      +                              },
      +                              "type": "object"
      +                            },
      +                            "range": {
      +                              "description": "Zero-based UTF-16 range.",
      +                              "properties": {
      +                                "length": {
      +                                  "description": "UTF-16 code-unit length.",
      +                                  "maximum": 2147483647,
      +                                  "minimum": 0,
      +                                  "type": "integer"
      +                                },
      +                                "start": {
      +                                  "description": "Zero-based UTF-16 offset.",
      +                                  "maximum": 2147483647,
      +                                  "minimum": 0,
      +                                  "type": "integer"
      +                                }
      +                              },
      +                              "type": "object"
      +                            }
      +                          },
      +                          "required": [
      +                            "document",
      +                            "range"
      +                          ],
      +                          "type": "object"
      +                        }
      +                      },
      +                      "required": [
      +                        "span"
      +                      ],
      +                      "type": [
      +                        "object",
      +                        "null"
      +                      ]
      +                    },
      +                    "snapshot": {
      +                      "description": "The exact immutable workspace snapshot associated with this location.",
      +                      "properties": {
      +                        "snapshotId": {
      +                          "format": "uuid",
      +                          "type": "string"
      +                        },
      +                        "transactionRevision": {
      +                          "type": [
      +                            "integer",
      +                            "null"
      +                          ]
      +                        },
      +                        "workspaceEpoch": {
      +                          "type": "integer"
      +                        },
      +                        "workspaceId": {
      +                          "format": "uuid",
      +                          "type": "string"
      +                        }
      +                      },
      +                      "required": [
      +                        "workspaceId",
      +                        "workspaceEpoch",
      +                        "snapshotId",
      +                        "transactionRevision"
      +                      ],
      +                      "type": "object"
      +                    },
      +                    "span": {
      +                      "description": "The resolved text span.",
      +                      "properties": {
      +                        "length": {
      +                          "description": "UTF-16 code-unit length.",
      +                          "maximum": 2147483647,
      +                          "minimum": 0,
      +                          "type": "integer"
      +                        },
      +                        "start": {
      +                          "description": "Zero-based UTF-16 offset.",
      +                          "maximum": 2147483647,
      +                          "minimum": 0,
      +                          "type": "integer"
      +                        }
      +                      },
      +                      "type": [
      +                        "object",
      +                        "null"
      +                      ]
      +                    }
      +                  },
      +                  "required": [
      +                    "snapshot"
      +                  ],
      +                  "type": [
      +                    "object",
      +                    "null"
      +                  ]
      +                }
      +              },
      +              "required": [
      +                "displayName",
      +                "kind"
      +              ],
      +              "type": [
      +                "object",
      +                "null"
      +              ]
      +            },
      +            "type": {
      +              "description": "The containing or declared type information, when applicable.",
      +              "properties": {
      +                "displayName": {
      +                  "description": "The display name.",
      +                  "type": "string"
      +                },
      +                "documentationCommentId": {
      +                  "description": "The documentation-comment identifier, when available.",
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "kind": {
      +                  "description": "The Roslyn type kind.",
      +                  "type": "string"
      +                },
      +                "nullableAnnotation": {
      +                  "description": "The nullable annotation.",
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                }
      +              },
      +              "required": [
      +                "displayName",
      +                "kind"
      +              ],
      +              "type": [
      +                "object",
      +                "null"
      +              ]
      +            }
      +          },
      +          "required": [
      +            "accessibility"
      +          ],
      +          "type": [
      +            "object",
      +            "null"
      +          ]
      +        },
      +        "ok": {
      +          "const": true,
      +          "description": "Whether the tool invocation succeeded."
      +        },
      +        "snapshot": {
      +          "description": "Exact immutable workspace snapshot associated with the result, when available.",
      +          "properties": {
      +            "snapshotId": {
      +              "format": "uuid",
      +              "type": "string"
      +            },
      +            "transactionRevision": {
      +              "type": [
      +                "integer",
      +                "null"
      +              ]
      +            },
      +            "workspaceEpoch": {
      +              "type": "integer"
      +            },
      +            "workspaceId": {
      +              "format": "uuid",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "workspaceId",
      +            "workspaceEpoch",
      +            "snapshotId",
      +            "transactionRevision"
      +          ],
      +          "type": "object"
      +        },
      +        "warnings": {
      +          "description": "Non-fatal warnings the agent should consider.",
      +          "items": {
      +            "$ref": "#/$defs/warningInfo"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "ok",
      +        "data",
      +        "snapshot"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "properties": {
      +        "continuation": {
      +          "description": "Action the agent should take before retrying or continuing.",
      +          "oneOf": [
      +            {
      +              "additionalProperties": false,
      +              "properties": {
      +                "instruction": {
      +                  "description": "Agent-facing instruction explaining how to continue.",
      +                  "minLength": 1,
      +                  "type": "string"
      +                },
      +                "kind": {
      +                  "const": "CallTool",
      +                  "description": "Action required before the original request can continue."
      +                },
      +                "tool": {
      +                  "description": "Tool to call before continuing the original request.",
      +                  "minLength": 1,
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "kind",
      +                "tool",
      +                "instruction"
      +              ],
      +              "type": "object"
      +            },
      +            {
      +              "additionalProperties": false,
      +              "properties": {
      +                "instruction": {
      +                  "description": "Agent-facing instruction explaining how to continue.",
      +                  "minLength": 1,
      +                  "type": "string"
      +                },
      +                "kind": {
      +                  "const": "ChooseTool",
      +                  "description": "Action required before the original request can continue."
      +                },
      +                "tools": {
      +                  "description": "Allowed tool choices from which the agent must select one.",
      +                  "items": {
      +                    "description": "Name of a tool the agent may choose.",
      +                    "minLength": 1,
      +                    "type": "string"
      +                  },
      +                  "minItems": 1,
      +                  "type": "array",
      +                  "uniqueItems": true
      +                }
      +              },
      +              "required": [
      +                "kind",
      +                "tools",
      +                "instruction"
      +              ],
      +              "type": "object"
      +            },
      +            {
      +              "additionalProperties": false,
      +              "properties": {
      +                "instruction": {
      +                  "description": "Agent-facing instruction explaining how to continue.",
      +                  "minLength": 1,
      +                  "type": "string"
      +                },
      +                "kind": {
      +                  "const": "RetryRequest",
      +                  "description": "Action required before the original request can continue."
      +                }
      +              },
      +              "required": [
      +                "kind",
      +                "instruction"
      +              ],
      +              "type": "object"
      +            },
      +            {
      +              "additionalProperties": false,
      +              "properties": {
      +                "instruction": {
      +                  "description": "Agent-facing instruction explaining how to continue.",
      +                  "minLength": 1,
      +                  "type": "string"
      +                },
      +                "kind": {
      +                  "const": "ReviseRequest",
      +                  "description": "Action required before the original request can continue."
      +                }
      +              },
      +              "required": [
      +                "kind",
      +                "instruction"
      +              ],
      +              "type": "object"
      +            },
      +            {
      +              "additionalProperties": false,
      +              "properties": {
      +                "instruction": {
      +                  "description": "Agent-facing instruction explaining how to continue.",
      +                  "minLength": 1,
      +                  "type": "string"
      +                },
      +                "kind": {
      +                  "const": "ResolveExternally",
      +                  "description": "Action required before the original request can continue."
      +                }
      +              },
      +              "required": [
      +                "kind",
      +                "instruction"
      +              ],
      +              "type": "object"
      +            }
      +          ]
      +        },
      +        "diagnostics": {
      +          "description": "Diagnostics that explain the failed invocation.",
      +          "items": {
      +            "properties": {
      +              "id": {
      +                "description": "The diagnostic identifier.",
      +                "type": "string"
      +              },
      +              "location": {
      +                "description": "The optional source location of the diagnostic.",
      +                "properties": {
      +                  "column": {
      +                    "description": "The one-based column number.",
      +                    "type": "integer"
      +                  },
      +                  "document": {
      +                    "description": "The resolved document.",
      +                    "properties": {
      +                      "documentId": {
      +                        "description": "The document identifier.",
      +                        "type": "string"
      +                      },
      +                      "path": {
      +                        "description": "The normalized document path.",
      +                        "type": "string"
      +                      },
      +                      "projectId": {
      +                        "description": "The owning project identifier.",
      +                        "type": "string"
      +                      }
      +                    },
      +                    "required": [
      +                      "documentId",
      +                      "path",
      +                      "projectId"
      +                    ],
      +                    "type": [
      +                      "object",
      +                      "null"
      +                    ]
      +                  },
      +                  "line": {
      +                    "description": "The one-based line number.",
      +                    "type": "integer"
      +                  },
      +                  "selector": {
      +                    "description": "The canonical selector that can resolve this source location again.",
      +                    "properties": {
      +                      "span": {
      +                        "properties": {
      +                          "document": {
      +                            "description": "Provide exactly one of path or documentId.",
      +                            "properties": {
      +                              "documentId": {
      +                                "description": "Workspace-local document ID.",
      +                                "type": [
      +                                  "string",
      +                                  "null"
      +                                ]
      +                              },
      +                              "path": {
      +                                "description": "Workspace-relative path.",
      +                                "type": [
      +                                  "string",
      +                                  "null"
      +                                ]
      +                              },
      +                              "project": {
      +                                "description": "Disambiguates documents with matching paths or IDs.",
      +                                "properties": {
      +                                  "name": {
      +                                    "type": [
      +                                      "string",
      +                                      "null"
      +                                    ]
      +                                  },
      +                                  "path": {
      +                                    "description": "Workspace-relative path.",
      +                                    "type": [
      +                                      "string",
      +                                      "null"
      +                                    ]
      +                                  },
      +                                  "projectId": {
      +                                    "type": [
      +                                      "string",
      +                                      "null"
      +                                    ]
      +                                  },
      +                                  "targetFramework": {
      +                                    "type": [
      +                                      "string",
      +                                      "null"
      +                                    ]
      +                                  }
      +                                },
      +                                "type": [
      +                                  "object",
      +                                  "null"
      +                                ]
      +                              }
      +                            },
      +                            "type": "object"
      +                          },
      +                          "range": {
      +                            "description": "Zero-based UTF-16 range.",
      +                            "properties": {
      +                              "length": {
      +                                "description": "UTF-16 code-unit length.",
      +                                "maximum": 2147483647,
      +                                "minimum": 0,
      +                                "type": "integer"
      +                              },
      +                              "start": {
      +                                "description": "Zero-based UTF-16 offset.",
      +                                "maximum": 2147483647,
      +                                "minimum": 0,
      +                                "type": "integer"
      +                              }
      +                            },
      +                            "type": "object"
      +                          }
      +                        },
      +                        "required": [
      +                          "document",
      +                          "range"
      +                        ],
      +                        "type": "object"
      +                      }
      +                    },
      +                    "required": [
      +                      "span"
      +                    ],
      +                    "type": [
      +                      "object",
      +                      "null"
      +                    ]
      +                  },
      +                  "snapshot": {
      +                    "description": "The exact immutable workspace snapshot associated with this location.",
      +                    "properties": {
      +                      "snapshotId": {
      +                        "format": "uuid",
      +                        "type": "string"
      +                      },
      +                      "transactionRevision": {
      +                        "type": [
      +                          "integer",
      +                          "null"
      +                        ]
      +                      },
      +                      "workspaceEpoch": {
      +                        "type": "integer"
      +                      },
      +                      "workspaceId": {
      +                        "format": "uuid",
      +                        "type": "string"
      +                      }
      +                    },
      +                    "required": [
      +                      "workspaceId",
      +                      "workspaceEpoch",
      +                      "snapshotId",
      +                      "transactionRevision"
      +                    ],
      +                    "type": "object"
      +                  },
      +                  "span": {
      +                    "description": "The resolved text span.",
      +                    "properties": {
      +                      "length": {
      +                        "description": "UTF-16 code-unit length.",
      +                        "maximum": 2147483647,
      +                        "minimum": 0,
      +                        "type": "integer"
      +                      },
      +                      "start": {
      +                        "description": "Zero-based UTF-16 offset.",
      +                        "maximum": 2147483647,
      +                        "minimum": 0,
      +                        "type": "integer"
      +                      }
      +                    },
      +                    "type": [
      +                      "object",
      +                      "null"
      +                    ]
      +                  }
      +                },
      +                "required": [
      +                  "snapshot"
      +                ],
      +                "type": [
      +                  "object",
      +                  "null"
      +                ]
      +              },
      +              "message": {
      +                "description": "The diagnostic message.",
      +                "type": "string"
      +              },
      +              "severity": {
      +                "description": "The diagnostic severity.",
      +                "enum": [
      +                  "Hidden",
      +                  "Info",
      +                  "Warning",
      +                  "Error"
      +                ],
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "id",
      +              "message"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "error": {
      +          "description": "Structured error details when the invocation failed.",
      +          "properties": {
      +            "code": {
      +              "description": "Stable machine-readable error code.",
      +              "type": "string"
      +            },
      +            "correlationId": {
      +              "description": "Correlation identifier for matching the failure to server-side diagnostics, when available.",
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "message": {
      +              "description": "Human-readable explanation of the failure.",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "code",
      +            "message"
      +          ],
      +          "type": "object"
      +        },
      +        "ok": {
      +          "const": false,
      +          "description": "Whether the tool invocation succeeded."
      +        },
      +        "warnings": {
      +          "description": "Non-fatal warnings the agent should consider.",
      +          "items": {
      +            "$ref": "#/$defs/warningInfo"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "ok",
      +        "error"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "properties": {
      +        "diagnostics": {
      +          "description": "Diagnostics that explain the failed invocation.",
      +          "properties": {
      +            "detailsAvailable": {
      +              "const": true
      +            },
      +            "detailsTool": {
      +              "const": "get-error-details"
      +            }
      +          },
      +          "required": [
      +            "detailsAvailable",
      +            "detailsTool"
      +          ],
      +          "type": "object"
      +        },
      +        "error": {
      +          "description": "Structured error details when the invocation failed.",
      +          "properties": {
      +            "code": {
      +              "const": "UnhandledException"
      +            },
      +            "correlationId": {
      +              "format": "uuid",
      +              "type": "string"
      +            },
      +            "message": {
      +              "const": "Tool execution failed."
      +            }
      +          },
      +          "required": [
      +            "code",
      +            "message",
      +            "correlationId"
      +          ],
      +          "type": "object"
      +        },
      +        "ok": {
      +          "const": false,
      +          "description": "Whether the tool invocation succeeded."
      +        },
      +        "reporting": {
      +          "description": "Error-reporting workflow available for an unhandled failure.",
      +          "properties": {
      +            "canPrepare": {
      +              "type": "boolean"
      +            },
      +            "prepareTool": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "state": {
      +              "enum": [
      +                "Available",
      +                "AlwaysApproved",
      +                "DisabledByConfiguration",
      +                "ApprovalUnavailable"
      +              ],
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "state"
      +          ],
      +          "type": "object"
      +        }
      +      },
      +      "required": [
      +        "ok",
      +        "error",
      +        "diagnostics"
      +      ],
      +      "type": "object"
      +    }
      +  ],
      +  "type": "object"
      +}
  3. First observedv1.0.2

TDQS

A4.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint/idempotentHint true and destructiveHint false, so the safety profile is covered by structured data. The description adds genuine behavioral context beyond that: XML docs are opt-in via includeDocumentation, results are bounded by independent declaration/parameter limits, truncation is signalled through declarations.hasMore and parameters.hasMore, and metadata-only symbols may return no source declarations. It does not address snapshot/expectedSnapshot concurrency semantics, but with annotations and an output schema present this is a solid contribution rather than an exceptional one.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the purpose, then alternatives, then pagination and an edge case, so ordering is sensible and every sentence carries information. It is somewhat dense, packing limits, hasMore flags and the documentation flag into single clauses, but nothing is filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, return values need no explanation, and annotations cover safety. The description still supplies the things structured fields cannot: upstream tool sequencing, sibling routing, independent bound defaults, truncation signals, and the metadata-only-symbol edge case. An agent has everything needed to call this correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description still adds meaning beyond the schema: it explains that includeDocumentation is an opt-in switch for XML docs, that declarations and parameters are bounded independently (32/64), and how hasMore flags signal truncation. It says nothing about the symbol selector, workspace, or expectedSnapshot parameters, which the schema already handles via its own descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Specific verb ('Inspects') plus a precisely scoped resource ('one resolved symbol'), followed by an enumeration of what is returned: accessibility, modifiers, associated type, declaration locations, parameters and return type. It also explicitly distinguishes itself from siblings by noting it operates on an already-resolved declaration, which the agent can tell apart from search-symbols or get-symbol-members without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

States the sequencing ('Use this after search-symbols or resolve-symbol') and names two alternatives with the conditions that select them ('use find-references for its usages or get-symbol-members to enumerate type members'). Both when-to-use and when-not-to-use are covered explicitly.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.