Workspace Status

workspace-status · Query · Server · Workspaces

Reports the selected workspace lifecycle and cross-instance state. Treat a workspace that is or may be in use elsewhere as query-only, use it only when necessary, and expect results to become stale.

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	"Workspace Status"

Request

Property	Type	Required	Description
detail	string enum ("Minimal", "Standard", "Full")	No	Amount of workspace status detail 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	No	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": {
    "detail": {
      "description": "Amount of workspace status detail to return.",
      "type": "string",
      "enum": [
        "Minimal",
        "Standard",
        "Full"
      ]
    },
    "workspace": {
      "description": "Provide workspaceId, alias, path, or any combination.",
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "workspaceId": {
          "type": "string",
          "format": "uuid"
        },
        "alias": {
          "type": "string"
        },
        "path": {
          "description": "Absolute workspace path.",
          "type": "string"
        }
      }
    }
  }
}

Complete output schema

{
  "type": "object",
  "oneOf": [
    {
      "type": "object",
      "required": [
        "ok",
        "data"
      ],
      "properties": {
        "ok": {
          "const": true,
          "description": "Whether the tool invocation succeeded."
        },
        "data": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "state": {
              "description": "The workspace lifecycle state.",
              "type": "string",
              "enum": [
                "Ready",
                "TransactionActive",
                "TransactionConflicted",
                "WorkspaceOutOfDate"
              ]
            },
            "workspace": {
              "description": "The loaded workspace identity, when present.",
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "workspaceId": {
                  "description": "The stable server-generated workspace identifier.",
                  "type": "string",
                  "format": "uuid"
                },
                "alias": {
                  "description": "The optional caller-friendly alias.",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "workspaceEpoch": {
                  "description": "The workspace epoch for the loaded baseline.",
                  "type": "integer"
                },
                "loadedPath": {
                  "description": "The absolute path of the loaded workspace.",
                  "type": "string"
                },
                "workspaceRoot": {
                  "description": "The absolute repository or workspace root used for coordination and transaction boundaries.",
                  "type": "string"
                }
              },
              "required": [
                "loadedPath",
                "workspaceRoot"
              ]
            },
            "projectCount": {
              "description": "The loaded project count, when present.",
              "type": [
                "integer",
                "null"
              ]
            },
            "documentCount": {
              "description": "The loaded document count, when present.",
              "type": [
                "integer",
                "null"
              ]
            },
            "loadDiagnostics": {
              "description": "Project load and advisory workspace-status diagnostics.",
              "type": [
                "array",
                "null"
              ],
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "description": "The diagnostic identifier.",
                    "type": "string"
                  },
                  "severity": {
                    "description": "The diagnostic severity.",
                    "type": "string",
                    "enum": [
                      "Hidden",
                      "Info",
                      "Warning",
                      "Error"
                    ]
                  },
                  "message": {
                    "description": "The diagnostic message.",
                    "type": "string"
                  },
                  "location": {
                    "description": "The optional source location of the diagnostic.",
                    "type": [
                      "object",
                      "null"
                    ],
                    "properties": {
                      "document": {
                        "description": "The resolved document.",
                        "type": [
                          "object",
                          "null"
                        ],