Skip to main content
Glama

Get Document Options

get-document-options
Read-onlyIdempotent

Retrieve a document's language and optional parse/analyzer config details to inspect effective C# analysis settings and diagnose code behavior.

Instructions

Returns language and optional detailed parse and analyzer-config options for a document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentYesTarget document.
workspaceNoProvide workspaceId, alias, path, or any combination.
includeParseOptionsNoWhether to include parse options.
includeAnalyzerConfigNoWhether to include effective analyser configuration.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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": {
      +            "analyzerConfig": {
      +              "description": "The effective analyzer-config information.",
      +              "properties": {
      +                "editorConfigPaths": {
      +                  "description": "The editor-config file paths applied to the document.",
      +                  "items": {
      +                    "type": "string"
      +                  },
      +                  "type": "array"
      +                },
      +                "globalConfigPaths": {
      +                  "description": "The global analyzer-config file paths applied to the document.",
      +                  "items": {
      +                    "type": "string"
      +                  },
      +                  "type": "array"
      +                },
      +                "options": {
      +                  "additionalProperties": {
      +                    "type": "string"
      +                  },
      +                  "description": "The effective analyzer-config options for the document.",
      +                  "type": "object"
      +                }
      +              },
      +              "type": [
      +                "object",
      +                "null"
      +              ]
      +            },
      +            "document": {
      +              "description": "The resolved document reference.",
      +              "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"
      +              ]
      +            },
      +            "languageVersion": {
      +              "description": "The effective language version, when available for the document language.",
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "nullableContext": {
      +              "description": "The effective nullable context, when available for the document language.",
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "parseOptions": {
      +              "description": "The effective parse options.",
      +              "properties": {
      +                "documentationMode": {
      +                  "description": "The documentation mode.",
      +                  "type": "string"
      +                },
      +                "language": {
      +                  "description": "The language name.",
      +                  "type": "string"
      +                },
      +                "languageVersion": {
      +                  "description": "The language version, when available for the project language.",
      +                  "type": [
      +                    "string",
      +                    "null"
      +                  ]
      +                },
      +                "preprocessorSymbols": {
      +                  "description": "The effective preprocessor symbols.",
      +                  "items": {
      +                    "type": "string"
      +                  },
      +                  "type": "array"
      +                }
      +              },
      +              "required": [
      +                "language",
      +                "documentationMode"
      +              ],
      +              "type": [
      +                "object",
      +                "null"
      +              ]
      +            }
      +          },
      +          "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"
      +}
  2. First observedv1.0.2

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare the full safety profile (readOnlyHint, idempotentHint, destructiveHint false), so the bar is lower. The description adds nothing behavioral beyond that — no note on whether parse/analyzer options reflect cached vs. on-disk state, or cost/expense considerations, despite the 'effective analyser configuration' wording implying computed state.

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?

A single tight sentence that is front-loaded with the verb and resource; nothing is wasted. It is terse to the point of slight under-specification, but structurally clean.

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

Completeness3/5

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

An output schema exists, so return values need not be explained, and the schema fully covers the 4 parameters. The description is adequate but thin for a tool with nested document/workspace disambiguation semantics — it explains neither when the computed options are useful nor which option set applies.

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

Parameters3/5

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

Schema coverage is 100%, so the schema already documents every parameter including the nested document and workspace objects. The description loosely echoes includeParseOptions/includeAnalyzerConfig ('optional detailed parse and analyzer-config options') but adds no syntax or format detail beyond the schema, so the baseline 3 applies.

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

Purpose4/5

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

States a specific verb+resource ('Returns ... options for a document') and enumerates the option categories returned (language, parse, analyzer-config). Clear enough to distinguish from analytical siblings like get-document-outline or analyze-*, though it doesn't explicitly name what it is not.

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

Usage Guidelines2/5

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

The description only declares what is returned; it gives no when-to-use guidance, no prerequisites, and no indication of how it differs from related tools such as get-document-outline or get-code-context. Usage is left entirely to inference from the tool name.

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