Skip to content

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 by default.

Generated from Roslyn Workbench MCP 0.1.0-beta.304 (0.1.0-beta.304).

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.

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.

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 non-success response may include a structured continuation at the following schema location. Follow its tool call or user-action instruction instead of guessing how to retry:

  • $/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": {