Roslyn Workbench MCP

Overview Schema Source Related Servers Discussions Admin

Get Solution Structure

get-solution-structure

Read-onlyIdempotent

Maps a loaded solution into folders, projects, target frameworks, and direct references so you can discover project and document selectors before querying dependencies or code.

Instructions

Maps the loaded solution into solution folders and projects with workspace-relative paths, target frameworks and direct project references. Use this first to discover project and document selectors; use get-dependency-graph for a dependency graph or get-code-context to read a selected source region. Documents are omitted unless includeDocuments=true. Independent limits default to 200 folders, 100 projects, 50 references per project and 200 documents per project. Returns solutionPath and bounded folders and projects collections; check their hasMore flags and those on each projectReferences or documents collection for truncation. This read-only query can report ProjectStructureUnavailable if hierarchy or target-framework information cannot be obtained.

Input Schema

Name	Required	Description
`workspace`	No	Provide workspaceId, alias, path, or any combination.
`foldersLimit`	No	Maximum number of folders to return.
`projectsLimit`	No	Maximum number of projects to return.
`includeDocuments`	No	Whether documents should be included in project projections.
`documentsPerProjectLimit`	No	Maximum number of documents to return for each project.
`projectReferencesPerProjectLimit`	No	Maximum number of direct project references to return for each project.

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv1.0.4Oct 15, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$defs": {
+    "warningInfo": {
+      "properties": {
+        "code": {
+          "description": "The stable machine-readable warning code.",
+          "type": "string"
+        },
+        "message": {
+          "description": "The human-readable warning message.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "code",
+        "message"
+      ],
+      "type": "object"
+    }
+  },
+  "oneOf": [
+    {
+      "properties": {
+        "data": {
+          "description": "Tool-specific result payload.",
+          "properties": {
+            "folders": {
+              "description": "The solution folders.",
+              "properties": {
+                "hasMore": {
+                  "description": "Whether additional items were available beyond this page.",
+                  "type": "boolean"
+                },
+                "items": {
+                  "description": "Items returned in this page.",
+                  "items": {
+                    "properties": {
+                      "name": {
+                        "type": "string"
+                      },
+                      "parentPath": {
+                        "type": [
+                          "string",
+                          "null"
+                        ]
+                      },
+                      "path": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "name",
+                      "path"
+                    ],
+                    "type": "object"
+                  },
+                  "type": [
+                    "array",
+                    "null"
+                  ]
+                },
+                "totalCount": {
+                  "description": "Complete result count, when available without additional expensive work.",
+                  "type": [
+                    "integer",
+                    "null"
+                  ]
+                }
+              },
+              "type": "object"
+            },
+            "projects": {
+              "description": "The project structure projections.",
+              "properties": {
+                "hasMore": {
+                  "description": "Whether additional items were available beyond this page.",
+                  "type": "boolean"
+                },
+                "items": {
+                  "description": "Items returned in this page.",
+                  "items": {
+                    "properties": {
+                      "documents": {
+                        "description": "The project documents, when included.",
+                        "properties": {
+                          "hasMore": {
+                            "description": "Whether additional items were available beyond this page.",
+                            "type": "boolean"
+                          },
+                          "items": {
+                            "description": "Items returned in this page.",
+                            "items": {
+                              "properties": {
+                                "documentId": {
+                                  "description": "The document identifier.",
+                                  "type": "string"
+                                },
+                                "path": {
+                                  "description": "The normalized document path.",
+                                  "type": "string"
+                                },
+                                "projectId": {
+                                  "description": "The owning project identifier.",
+                                  "type": "string"
+                                }
+                              },
+                              "required": [
+                                "documentId",
+                                "path",
+                                "projectId"
+                              ],
+                              "type": "object"
+                            },
+                            "type": [
+                              "array",
+                              "null"
+                            ]
+                          },
+                          "totalCount": {
+                            "description": "Complete result count, when available without additional expensive work.",
+                            "type": [
+                              "integer",
+                              "null"
+                            ]
+                          }
+                        },
+                        "type": [
+                          "object",
+                          "null"
+                        ]
+                      },
+                      "name": {
+                        "description": "The project name.",
+                        "type": "string"
+                      },
+                      "path": {
+                        "description": "The project path.",
+                        "type": "string"
+                      },
+                      "projectId": {
+                        "description": "The project identifier.",
+                        "type": "string"
+                      },
+                      "projectReferences": {
+                        "description": "The direct project references.",
+                        "properties": {
+                          "hasMore": {
+                            "description": "Whether additional items were available beyond this page.",
+                            "type": "boolean"
+                          },
+                          "items": {
+                            "description": "Items returned in this page.",
+                            "items": {
+                              "properties": {
+                                "name": {
+                                  "description": "The referenced project name.",
+                                  "type": "string"
+                                },
+                                "path": {
+                                  "description": "The referenced project path.",
+                                  "type": "string"
+                                },
+                                "projectId": {
+                                  "description": "The referenced project identifier.",
+                                  "type": "string"
+                                }
+                              },
+                              "required": [
+                                "projectId",
+                                "name",
+                                "path"
+                              ],
+                              "type": "object"
+                            },
+                            "type": [
+                              "array",
+                              "null"
+                            ]
+                          },
+                          "totalCount": {
+                            "description": "Complete result count, when available without additional expensive work.",
+                            "type": [
+                              "integer",
+                              "null"
+                            ]
+                          }
+                        },
+                        "type": "object"
+                      },
+                      "solutionFolderPath": {
+                        "description": "The associated solution-folder path, when available.",
+                        "type": [
+                          "string",
+                          "null"
+                        ]
+                      },
+                      "targetFrameworks": {
+                        "description": "The target frameworks inferred for the project.",
+                        "items": {
+                          "type": "string"
+                        },
+                        "type": "array"
+                      }
+                    },
+                    "required": [
+                      "projectId",
+                      "name",
+                      "path"
+                    ],
+                    "type": "object"
+                  },
+                  "type": [
+                    "array",
+                    "null"
+                  ]
+                },
+                "totalCount": {
+                  "description": "Complete result count, when available without additional expensive work.",
+                  "type": [
+                    "integer",
+                    "null"
+                  ]
+                }
+              },
+              "type": "object"
+            },
+            "solutionPath": {
+              "description": "The loaded solution or project path.",
+              "type": "string"
+            }
+          },
+          "required": [
+            "solutionPath"
+          ],
+          "type": [
+            "object",
+            "null"
+          ]
+        },
+        "ok": {
+          "const": true,
+          "description": "Whether the tool invocation succeeded."
+        },
+        "snapshot": {
+          "description": "Exact immutable workspace snapshot associated with the result, when available.",
+          "properties": {
+            "snapshotId": {
+              "format": "uuid",
+              "type": "string"
+            },
+            "transactionRevision": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "workspaceEpoch": {
+              "type": "integer"
+            },
+            "workspaceId": {
+              "format": "uuid",
+              "type": "string"
+            }
+          },
+          "required": [
+            "workspaceId",
+            "workspaceEpoch",
+            "snapshotId",
+            "transactionRevision"
+          ],
+          "type": "object"
+        },
+        "warnings": {
+          "description": "Non-fatal warnings the agent should consider.",
+          "items": {
+            "$ref": "#/$defs/warningInfo"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "ok",
+        "data",
+        "snapshot"
+      ],
+      "type": "object"
+    },
+    {
+      "properties": {
+        "continuation": {
+          "description": "Action the agent should take before retrying or continuing.",
+          "oneOf": [
+            {
+              "additionalProperties": false,
+              "properties": {
+                "instruction": {
+                  "description": "Agent-facing instruction explaining how to continue.",
+                  "minLength": 1,
+                  "type": "string"
+                },
+                "kind": {
+                  "const": "CallTool",
+                  "description": "Action required before the original request can continue."
+                },
+                "tool": {
+                  "description": "Tool to call before continuing the original request.",
+                  "minLength": 1,
+                  "type": "string"
+                }
+              },
+              "required": [
+                "kind",
+                "tool",
+                "instruction"
+              ],
+              "type": "object"
+            },
+            {
+              "additionalProperties": false,
+              "properties": {
+                "instruction": {
+                  "description": "Agent-facing instruction explaining how to continue.",
+                  "minLength": 1,
+                  "type": "string"
+                },
+                "kind": {
+                  "const": "ChooseTool",
+                  "description": "Action required before the original request can continue."
+                },
+                "tools": {
+                  "description": "Allowed tool choices from which the agent must select one.",
+                  "items": {
+                    "description": "Name of a tool the agent may choose.",
+                    "minLength": 1,
+                    "type": "string"
+                  },
+                  "minItems": 1,
+                  "type": "array",
+                  "uniqueItems": true
+                }
+              },
+              "required": [
+                "kind",
+                "tools",
+                "instruction"
+              ],
+              "type": "object"
+            },
+            {
+              "additionalProperties": false,
+              "properties": {
+                "instruction": {
+                  "description": "Agent-facing instruction explaining how to continue.",
+                  "minLength": 1,
+                  "type": "string"
+                },
+                "kind": {
+                  "const": "RetryRequest",
+                  "description": "Action required before the original request can continue."
+                }
+              },
+              "required": [
+                "kind",
+                "instruction"
+              ],
+              "type": "object"
+            },
+            {
+              "additionalProperties": false,
+              "properties": {
+                "instruction": {
+                  "description": "Agent-facing instruction explaining how to continue.",
+                  "minLength": 1,
+                  "type": "string"
+                },
+                "kind": {
+                  "const": "ReviseRequest",
+                  "description": "Action required before the original request can continue."
+                }
+              },
+              "required": [
+                "kind",
+                "instruction"
+              ],
+              "type": "object"
+            },
+            {
+              "additionalProperties": false,
+              "properties": {
+                "instruction": {
+                  "description": "Agent-facing instruction explaining how to continue.",
+                  "minLength": 1,
+                  "type": "string"
+                },
+                "kind": {
+                  "const": "ResolveExternally",
+                  "description": "Action required before the original request can continue."
+                }
+              },
+              "required": [
+                "kind",
+                "instruction"
+              ],
+              "type": "object"
+            }
+          ]
+        },
+        "diagnostics": {
+          "description": "Diagnostics that explain the failed invocation.",
+          "items": {
+            "properties": {
+              "id": {
+                "description": "The diagnostic identifier.",
+                "type": "string"
+              },
+              "location": {
+                "description": "The optional source location of the diagnostic.",
+                "properties": {
+                  "column": {
+                    "description": "The one-based column number.",
+                    "type": "integer"
+                  },
+                  "document": {
+                    "description": "The resolved document.",
+                    "properties": {
+                      "documentId": {
+                        "description": "The document identifier.",
+                        "type": "string"
+                      },
+                      "path": {
+                        "description": "The normalized document path.",
+                        "type": "string"
+                      },
+                      "projectId": {
+                        "description": "The owning project identifier.",
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "documentId",
+                      "path",
+                      "projectId"
+                    ],
+                    "type": [
+                      "object",
+                      "null"
+                    ]
+                  },
+                  "line": {
+                    "description": "The one-based line number.",
+                    "type": "integer"
+                  },
+                  "selector": {
+                    "description": "The canonical selector that can resolve this source location again.",
+                    "properties": {
+                      "span": {
+                        "properties": {
+                          "document": {
+                            "description": "Provide exactly one of path or documentId.",
+                            "properties": {
+                              "documentId": {
+                                "description": "Workspace-local document ID.",
+                                "type": [
+                                  "string",
+                                  "null"
+                                ]
+                              },
+                              "path": {
+                                "description": "Workspace-relative path.",
+                                "type": [
+                                  "string",
+                                  "null"
+                                ]
+                              },
+                              "project": {
+                                "description": "Disambiguates documents with matching paths or IDs.",
+                                "properties": {
+                                  "name": {
+                                    "type": [
+                                      "string",
+                                      "null"
+                                    ]
+                                  },
+                                  "path": {
+                                    "description": "Workspace-relative path.",
+                                    "type": [
+                                      "string",
+                                      "null"
+                                    ]
+                                  },
+                                  "projectId": {
+                                    "type": [
+                                      "string",
+                                      "null"
+                                    ]
+                                  },
+                                  "targetFramework": {
+                                    "type": [
+                                      "string",
+                                      "null"
+                                    ]
+                                  }
+                                },
+                                "type": [
+                                  "object",
+                                  "null"
+                                ]
+                              }
+                            },
+                            "type": "object"
+                          },
+                          "range": {
+                            "description": "Zero-based UTF-16 range.",
+                            "properties": {
+                              "length": {
+                                "description": "UTF-16 code-unit length.",
+                                "maximum": 2147483647,
+                                "minimum": 0,
+                                "type": "integer"
+                              },
+                              "start": {
+                                "description": "Zero-based UTF-16 offset.",
+                                "maximum": 2147483647,
+                                "minimum": 0,
+                                "type": "integer"
+                              }
+                            },
+                            "type": "object"
+                          }
+                        },
+                        "required": [
+                          "document",
+                          "range"
+                        ],
+                        "type": "object"
+                      }
+                    },
+                    "required": [
+                      "span"
+                    ],
+                    "type": [
+                      "object",
+                      "null"
+                    ]
+                  },
+                  "snapshot": {
+                    "description": "The exact immutable workspace snapshot associated with this location.",
+                    "properties": {
+                      "snapshotId": {
+                        "format": "uuid",
+                        "type": "string"
+                      },
+                      "transactionRevision": {
+                        "type": [
+                          "integer",
+                          "null"
+                        ]
+                      },
+                      "workspaceEpoch": {
+                        "type": "integer"
+                      },
+                      "workspaceId": {
+                        "format": "uuid",
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "workspaceId",
+                      "workspaceEpoch",
+                      "snapshotId",
+                      "transactionRevision"
+                    ],
+                    "type": "object"
+                  },
+                  "span": {
+                    "description": "The resolved text span.",
+                    "properties": {
+                      "length": {
+                        "description": "UTF-16 code-unit length.",
+                        "maximum": 2147483647,
+                        "minimum": 0,
+                        "type": "integer"
+                      },
+                      "start": {
+                        "description": "Zero-based UTF-16 offset.",
+                        "maximum": 2147483647,
+                        "minimum": 0,
+                        "type": "integer"
+                      }
+                    },
+                    "type": [
+                      "object",
+                      "null"
+                    ]
+                  }
+                },
+                "required": [
+                  "snapshot"
+                ],
+                "type": [
+                  "object",
+                  "null"
+                ]
+              },
+              "message": {
+                "description": "The diagnostic message.",
+                "type": "string"
+              },
+              "severity": {
+                "description": "The diagnostic severity.",
+                "enum": [
+                  "Hidden",
+                  "Info",
+                  "Warning",
+                  "Error"
+                ],
+                "type": "string"
+              }
+            },
+            "required": [
+              "id",
+              "message"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "error": {
+          "description": "Structured error details when the invocation failed.",
+          "properties": {
+            "code": {
+              "description": "Stable machine-readable error code.",
+              "type": "string"
+            },
+            "correlationId": {
+              "description": "Correlation identifier for matching the failure to server-side diagnostics, when available.",
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "message": {
+              "description": "Human-readable explanation of the failure.",
+              "type": "string"
+            }
+          },
+          "required": [
+            "code",
+            "message"
+          ],
+          "type": "object"
+        },
+        "ok": {
+          "const": false,
+          "description": "Whether the tool invocation succeeded."
+        },
+        "warnings": {
+          "description": "Non-fatal warnings the agent should consider.",
+          "items": {
+            "$ref": "#/$defs/warningInfo"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "ok",
+        "error"
+      ],
+      "type": "object"
+    },
+    {
+      "properties": {
+        "diagnostics": {
+          "description": "Diagnostics that explain the failed invocation.",
+          "properties": {
+            "detailsAvailable": {
+              "const": true
+            },
+            "detailsTool": {
+              "const": "get-error-details"
+            }
+          },
+          "required": [
+            "detailsAvailable",
+            "detailsTool"
+          ],
+          "type": "object"
+        },
+        "error": {
+          "description": "Structured error details when the invocation failed.",
+          "properties": {
+            "code": {
+              "const": "UnhandledException"
+            },
+            "correlationId": {
+              "format": "uuid",
+              "type": "string"
+            },
+            "message": {
+              "const": "Tool execution failed."
+            }
+          },
+          "required": [
+            "code",
+            "message",
+            "correlationId"
+          ],
+          "type": "object"
+        },
+        "ok": {
+          "const": false,
+          "description": "Whether the tool invocation succeeded."
+        },
+        "reporting": {
+          "description": "Error-reporting workflow available for an unhandled failure.",
+          "properties": {
+            "canPrepare": {
+              "type": "boolean"
+            },
+            "prepareTool": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "state": {
+              "enum": [
+                "Available",
+                "AlwaysApproved",
+                "DisabledByConfiguration",
+                "ApprovalUnavailable"
+              ],
+              "type": "string"
+            }
+          },
+          "required": [
+            "state"
+          ],
+          "type": "object"
+        }
+      },
+      "required": [
+        "ok",
+        "error",
+        "diagnostics"
+      ],
+      "type": "object"
+    }
+  ],
+  "type": "object"
+}

First observedv1.0.2Oct 15, 2026

TDQS

A4.6/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover safety (readOnly, idempotent, non-destructive, closed-world), yet the description adds real behavioral value: documents omitted by default, independent default caps, hasMore truncation flags per collection, and the ProjectStructureUnavailable failure mode. Slightly short of 5 only because it doesn't characterize cost/latency or ordering of results.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the primary mapping statement, then usage routing, then limits and return/error behavior. Dense but every sentence carries information; mild density cost from packing limits and truncation semantics into one paragraph.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 6-parameter, zero-required read tool with an output schema, the description covers purpose, alternatives, default-inclusion behavior, truncation signaling, and the named error case. Nothing an agent needs in order to invoke it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description goes beyond by restating the four independent default limits and flagging that documents are excluded unless includeDocuments=true. It does not explain the workspace parameter's identifier resolution or the guidance for choosing smaller limits, so it adds meaningful but not complete semantic value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource: maps the loaded solution into folders/projects with workspace-relative paths, target frameworks and direct project references. It explicitly differentiates itself from sibling tools (get-dependency-graph, get-code-context), so an agent can select it without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit positioning ('Use this first to discover project and document selectors') and names two alternatives with their selecting conditions. Also states the includeDocuments prerequisite for returning documents, which is a concrete when/when-not rule.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server