Skip to main content
Glama
Sign In
Roslyn Workbench MCP

Roslyn Workbench MCP

by lantean-code
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

Get Document Outline

get-document-outline
Read-onlyIdempotent

Returns a semantic declaration tree for a single file, with names, kinds, locations and nested children, so you can navigate the structure of a document you already know.

Instructions

Returns a semantic declaration tree for one document, with names, kinds, locations and nested children. Use this to navigate the structure of a known file; use search-symbols to discover declarations across documents, or get-symbol-info for detailed symbol metadata. Members are included by default. Defaults to 200 projected nodes below the document root and 16 hierarchy levels. Check truncated for content omitted by the node or depth limit; root may be null when syntax or semantic information is unavailable.

Input Schema

NameRequiredDescriptionDefault
documentYesTarget document.
maxDepthNoThe maximum semantic hierarchy depth below the document root.
workspaceNoProvide workspaceId, alias, path, or any combination.
nodesLimitNoThe optional maximum total number of projected outline nodes.
includeMembersNoWhether member nodes should be included.

Output 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": {
+            "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"
+              ]
+            },
+            "root": {
+              "description": "The outline root node.",
+              "properties": {
+                "accessibility": {
+                  "description": "The optional accessibility.",
+                  "type": [
+                    "string",
+                    "null"
+                  ]
+                },
+                "children": {
+                  "description": "The child outline nodes.",
+                  "items": {
+                    "properties": {
+                      "accessibility": {
+                        "description": "The optional accessibility.",
+                        "type": [
+                          "string",
+                          "null"
+                        ]
+                      },
+                      "children": {
+                        "$ref": "#/properties/request/properties/value/properties/root/properties/children",
+                        "description": "The child outline nodes.",
+                        "items": {}
+                      },
+                      "kind": {
+                        "description": "The Roslyn symbol or declaration kind.",
+                        "type": "string"
+                      },
+                      "location": {
+                        "$ref": "#/properties/request/properties/value/properties/root/properties/location",
+                        "description": "The node location, when available."
+                      },
+                      "modifiers": {
+                        "$ref": "#/properties/request/properties/value/properties/root/properties/modifiers",
+                        "description": "The node modifiers.",
+                        "items": {}
+                      },
+                      "name": {
+                        "description": "The node display name.",
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "name",
+                      "kind"
+                    ],
+                    "type": "object"
+                  },
+                  "type": "array"
+                },
+                "kind": {
+                  "description": "The Roslyn symbol or declaration kind.",
+                  "type": "string"
+                },
+                "location": {
+                  "description": "The node location, when available.",
+                  "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"
+                  ]
+                },
+                "modifiers": {
+                  "description": "The node modifiers.",
+                  "items": {
+                    "type": "string"
+                  },
+                  "type": "array"
+                },
+                "name": {
+                  "description": "The node display name.",
+                  "type": "string"
+                }
+              },
+              "required": [
+                "name",
+                "kind"
+              ],
+              "type": [
+                "object",
+                "null"
+              ]
+            },
+            "truncated": {
+              "description": "Whether the hierarchy was truncated by its node or depth bound.",
+              "type": "boolean"
+            }
+          },
+          "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

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so safety is covered. The description adds non-obvious behavior beyond that: default node (200) and depth (16) caps, the truncated flag signaling omitted content, and root being null when syntax/semantic info is unavailable. It does not explain ordering or identity of nodes, keeping it short of a 5.

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 core statement, then alternatives, then defaults and edge cases; nearly every clause carries information. It is dense but not padded, though the final sentence stacks three separate facts that could be split more cleanly.

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?

An output schema exists, so return values need not be explained, and the description covers the remaining unknowns for a read-only outline tool: defaults, truncation, and the null-root failure mode. Nothing an agent needs to call it correctly is missing.

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 would be 3. The description nonetheless adds meaning to nodesLimit and maxDepth by tying them to the truncation flag and framing them as defaults rather than fixed limits, which is context the schema's raw max/min does not convey.

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?

States a specific verb and resource ('Returns a semantic declaration tree for one document') plus the shape of the result (names, kinds, locations, nested children). It explicitly names the sibling tools it is not (search-symbols, get-symbol-info), so an agent can distinguish it without opening schemas.

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?

Gives an explicit selection rule: use this for navigating the structure of a known file, use search-symbols to discover declarations across documents, and get-symbol-info for detailed symbol metadata. Both alternatives and the condition that selects them are named.

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

Deploy Server

Other Tools