Skip to content

Workspace List

workspace-list · Query · Server · Workspaces

Lists the currently loaded workspaces.

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 List"

Request

This object has no properties.

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

Examples

List open workspaces

Workflow: Open and select a workspace, step 1.

Operational modes: inspection-only, transactional, autonomous-trusted.

Discover the workspaces that are already available before opening another solution.

Expected outcome: A bounded inventory of open workspaces, or an empty inventory when none are open.

{}
Complete input schema
{
  "type": "object",
  "additionalProperties": false
}
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": {
            "workspaces": {
              "description": "The loaded workspaces.",
              "type": "array",
              "items": {
                "type": "object",
                "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"
                ]
              }
            },
            "transactionOwnerWorkspaceId": {
              "description": "The workspace identifier that currently owns the global transaction slot, when present.",
              "type": [
                "string",
                "null"
              ],
              "format": "uuid"
            }
          },
          "description": "Tool-specific result payload."
        },