Get Document Outline

get-document-outline · Query · CorePlugin · Code discovery and navigation

Returns a bounded semantic outline for one document.

Availability: Built in and published in every operational mode.

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

Behaviour annotations

Annotation	Value
`destructiveHint`	`false`
`idempotentHint`	`true`
`openWorldHint`	`false`
`readOnlyHint`	`true`
`title`	`"Get Document Outline"`

Request

Property	Type	Required	Description
`document`	`object`	Yes	Target document.
`includeMembers`	`boolean`	No	Whether member nodes should be included.
`maxDepth`	`integer`	No	The maximum semantic hierarchy depth below the document root.
`nodesLimit`	`integer \| null`	No	The optional maximum total number of projected outline nodes.
`workspace`	`object \| null`	No	Provide workspaceId, alias, path, or any combination.

Response

Success response

Property	Type	Required	Description
`ok`	`boolean constant (true)`	Yes	Whether the tool invocation succeeded.
`data`	`object \| null`	Yes	Tool-specific result payload.
`snapshot`	`object`	Yes	Exact immutable workspace snapshot associated with the result, when available.
`warnings`	`array`	No	Non-fatal warnings the agent should consider.

Error response

Property	Type	Required	Description
`ok`	`boolean constant (false)`	Yes	Whether the tool invocation succeeded.
`error`	`object`	Yes	Structured error details when the invocation failed.
`continuation`	`oneOf`	No	Action the agent should take before retrying or continuing.
`diagnostics`	`array`	No	Diagnostics that explain the failed invocation.
`warnings`	`array`	No	Non-fatal warnings the agent should consider.

Error response

Property	Type	Required	Description
`ok`	`boolean constant (false)`	Yes	Whether the tool invocation succeeded.
`error`	`object`	Yes	Structured error details when the invocation failed.
`diagnostics`	`object`	Yes	Diagnostics that explain the failed invocation.
`reporting`	`object`	No	Error-reporting workflow available for an unhandled failure.

Continuations and required actions

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

$/oneOf/1/properties/continuation

Complete input schema

{
  "type": "object",
  "properties": {
    "document": {
      "description": "Target document.",
      "type": "object",
      "properties": {
        "project": {
          "description": "Disambiguates documents with matching paths or IDs.",
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "projectId": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "path": {
              "description": "Workspace-relative path.",
              "type": "string"
            },
            "targetFramework": {
              "type": "string"
            }
          }
        },
        "path": {
          "description": "Workspace-relative path.",
          "type": "string"
        },
        "documentId": {
          "description": "Workspace-local document ID.",
          "type": "string"
        }
      }
    },
    "includeMembers": {
      "description": "Whether member nodes should be included.",
      "type": "boolean"
    },
    "maxDepth": {
      "description": "The maximum semantic hierarchy depth below the document root.",
      "type": "integer",
      "minimum": 0,