Get Project Details

get-project-details · Query · CorePlugin · Code discovery and navigation

Returns project metadata, options and selected document details.

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 Project Details"`

Request

Property	Type	Required	Description
`project`	`object`	Yes	Provide projectId, name, path, targetFramework, or any combination.
`includeDocuments`	`boolean`	No	Whether documents should be included.
`documentsLimit`	`integer \| null`	No	Maximum number of documents to return.
`projectReferencesLimit`	`integer \| null`	No	Maximum number of project references to return.
`metadataReferencesLimit`	`integer \| null`	No	Maximum number of metadata references to return.
`analyzersLimit`	`integer \| null`	No	Maximum number of analyzers to return.
`workspace`	`object \| null`	No	Provide workspaceId, alias, path, or any combination.

Response

Success response

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

Error response

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

Error response

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

Bounded collections and continuation

These response locations publish returned items with explicit bounds and continuation state:

$/oneOf/0/properties/data/properties/documents
$/oneOf/0/properties/data/properties/projectReferences
$/oneOf/0/properties/data/properties/metadataReferences
$/oneOf/0/properties/data/properties/analyzers

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": {
    "project": {
      "description": "Provide projectId, name, path, targetFramework, or any combination.",
      "type": "object",
      "properties": {
        "projectId": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "path": {
          "description": "Workspace-relative path.",
          "type": "string"
        },
        "targetFramework": {
          "type": "string"
        }
      }
    },
    "includeDocuments": {
      "description": "Whether documents should be included.",
      "type": "boolean"
    },
    "documentsLimit": {
      "description": "Maximum number of documents to return.",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "maximum": 2147483647,
      "default": 200
    },
    "projectReferencesLimit": {
      "description": "Maximum number of project references to return.",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "maximum": 2147483647,
      "default": 50
    },
    "metadataReferencesLimit": {
      "description": "Maximum number of metadata references to return.",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "maximum": 2147483647,
      "default": 100
    },
    "analyzersLimit": {
      "description": "Maximum number of analyzers to return.",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "maximum": 2147483647,
      "default": 50
    },
    "workspace": {
      "description": "Provide workspaceId, alias, path, or any combination.",
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "workspaceId": {
          "type": "string",
          "format": "uuid"
        },
        "alias": {
          "type": "string"
        },