Roslyn Workbench MCP

Overview Schema Source Related Servers Discussions Admin

Get Project Details

get-project-details

Read-onlyIdempotent

Inspect a selected C# project's target frameworks, compiler and parse options, project and metadata references, and analyzers to understand its configuration and dependencies.

Instructions

Inspects one selected project, returning target frameworks, compilation and parse options, project references, metadata references and analyzers. Use get-solution-structure to discover projects, then use this to inspect project configuration and dependencies. Document references are opt-in through includeDocuments and do not include file contents; use get-document-outline to inspect declarations in one document. Collections are bounded independently, including a default 200-document limit when requested. Check each returned collection for hasMore before treating it as complete.

Input Schema

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

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": {
+            "analyzers": {
+              "description": "The analyzer references.",
+              "properties": {
+                "hasMore": {
+                  "description": "Whether additional items were available beyond this page.",
+                  "type": "boolean"
+                },
+                "items": {
+                  "description": "Items returned in this page.",
+                  "items": {
+                    "properties": {
+                      "displayName": {
+                        "description": "The analyzer display name.",
+                        "type": "string"
+                      },
+                      "path": {
+                        "description": "The analyzer assembly path, when available.",
+                        "type": [
+                          "string",
+                          "null"
+                        ]
+                      }
+                    },
+                    "required": [
+                      "displayName"
+                    ],
+                    "type": "object"
+                  },
+                  "type": [
+                    "array",
+                    "null"
+                  ]
+                },
+                "totalCount": {
+                  "description": "Complete result count, when available without additional expensive work.",
+                  "type": [
+                    "integer",
+                    "null"
+                  ]
+                }
+              },
+              "type": "object"
+            },
+            "compilationOptions": {
+              "description": "The compilation options, when available.",
+              "properties": {
+                "allowUnsafe": {
+                  "description": "Whether unsafe code is allowed.",
+                  "type": "boolean"
+                },
+                "nullableContext": {
+                  "description": "The nullable context mode.",
+                  "type": [
+                    "string",
+                    "null"
+                  ]
+                },
+                "optimizationLevel": {
+                  "description": "The optimization level.",
+                  "type": "string"
+                },
+                "outputKind": {
+                  "description": "The output kind.",
+                  "type": "string"
+                },
+                "preprocessorSymbols": {
+                  "description": "The effective preprocessor symbols.",
+                  "items": {
+                    "type": "string"
+                  },
+                  "type": "array"
+                },
+                "warningLevel": {
+                  "description": "The warning level.",
+                  "type": "integer"
+                }
+              },
+              "required": [
+                "outputKind",
+                "optimizationLevel"
+              ],
+              "type": [
+                "object",
+                "null"
+              ]
+            },
+            "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"
+              ]
+            },
+            "metadataReferences": {
+              "description": "The metadata references.",
+              "properties": {
+                "hasMore": {
+                  "description": "Whether additional items were available beyond this page.",
+                  "type": "boolean"
+                },
+                "items": {
+                  "description": "Items returned in this page.",
+                  "items": {
+                    "properties": {
+                      "display": {
+                        "description": "The display string for the metadata reference.",
+                        "type": "string"
+                      },
+                      "path": {
+                        "description": "The file path, when available.",
+                        "type": [
+                          "string",
+                          "null"
+                        ]
+                      }
+                    },
+                    "required": [
+                      "display"
+                    ],
+                    "type": "object"
+                  },
+                  "type": [
+                    "array",
+                    "null"
+                  ]
+                },
+                "totalCount": {
+                  "description": "Complete result count, when available without additional expensive work.",
+                  "type": [
+                    "integer",
+                    "null"
+                  ]
+                }
+              },
+              "type": "object"
+            },
+            "project": {
+              "description": "The selected project information.",
+              "properties": {
+                "assemblyName": {
+                  "description": "The assembly name, when available.",
+                  "type": [
+                    "string",
+                    "null"
+                  ]
+                },
+                "language": {
+                  "description": "The project language.",
+                  "type": "string"
+                },
+                "name": {
+                  "description": "The project name.",
+                  "type": "string"
+                },
+                "path": {
+                  "description": "The project path.",
+                  "type": "string"
+                },
+                "projectId": {
+                  "description": "The project identifier.",
+                  "type": "string"
+                },
+                "targetFrameworks": {
+                  "description": "The target frameworks inferred for the project.",
+                  "items": {
+                    "type": "string"
+                  },
+                  "type": "array"
+                }
+              },
+              "required": [
+                "projectId",
+                "name",
+                "path",
+                "language"
+              ],
+              "type": [
+                "object",
+                "null"
+              ]
+            },
+            "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"
+            }
+          },
+          "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.8/5.0

Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds behavior those annotations cannot: documents are opt-in and exclude file contents, each collection is bounded independently, and callers must check hasMore per collection before treating results as complete. That truncation/pagination disclosure is exactly the non-obvious trait a consumer needs and is nowhere in the structured fields.

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 purpose and routing guidance, then behavior, then the hasMore caveat — a sensible ordering with little waste. The sentence about collection bounds partially duplicates the per-parameter default values already in the schema, and 'bounded independently' is slightly opaque, keeping it from a 5.

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 read-only inspection tool with an output schema, everything an agent needs is present: how to locate the project, what comes back, that documents are opt-in without contents, and that per-collection hasMore must be checked. No expected-to-know detail is left to inference.

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 baseline is 3; the description goes beyond it by explaining the semantic consequence of includeDocuments ('do not include file contents') rather than restating the schema's 'Whether documents should be included.' It still doesn't explain how project identity fields (projectId vs name vs path) are disambiguated or what happens on a limit of 0, so it stays below a 5.

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 and resource ('Inspects one selected project') and immediately enumerates the returned facets: target frameworks, compilation/parse options, project and metadata references, analyzers. It explicitly names the sibling tools it is not (get-solution-structure, get-document-outline), so an agent can distinguish it without opening any 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 an explicit workflow: 'Use get-solution-structure to discover projects, then use this to inspect project configuration and dependencies.' It also names the alternative for document-level inspection ('use get-document-outline'), and states that document references are opt-in via includeDocuments — covering when-not to use the documents path.

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

Deploy Server