Skip to main content
Glama

Get Error Details

get-error-details
Read-onlyIdempotent

Retrieve temporary local diagnostic details for a failed tool invocation using its correlation ID; for trusted local debugging only.

Instructions

Returns temporary local diagnostic details for an unexpected tool failure. The result may contain paths and user-authored identifiers, is intended only for the trusted local agent, and must never be submitted externally.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
correlationIdYesCorrelation identifier returned with the failed tool invocation.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.4
    • 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": {
      +            "error": {
      +              "description": "Captured diagnostic record for the failed tool invocation.",
      +              "properties": {
      +                "cancellationRequested": {
      +                  "description": "Whether cancellation had been requested when the failure occurred.",
      +                  "type": "boolean"
      +                },
      +                "correlationId": {
      +                  "description": "Correlation identifier assigned to the captured failure.",
      +                  "format": "uuid",
      +                  "type": "string"
      +                },
      +                "dotNetVersion": {
      +                  "description": ".NET runtime version used by the server.",
      +                  "type": "string"
      +                },
      +                "durationMilliseconds": {
      +                  "description": "Tool execution duration in milliseconds before failure.",
      +                  "type": "integer"
      +                },
      +                "exceptions": {
      +                  "description": "Captured exception chain for the failure.",
      +                  "items": {
      +                    "properties": {
      +                      "component": {
      +                        "description": "Roslyn Workbench component in which the exception originated.",
      +                        "enum": [
      +                          "Unknown",
      +                          "RoslynWorkbench",
      +                          "Roslyn",
      +                          "DotNet"
      +                        ],
      +                        "type": "string"
      +                      },
      +                      "message": {
      +                        "description": "Exception message included with the user's consent.",
      +                        "type": "string"
      +                      },
      +                      "stackFrames": {
      +                        "description": "Diagnostic stack frames retained from the exception and classified by owning component.",
      +                        "items": {
      +                          "properties": {
      +                            "assembly": {
      +                              "description": "Assembly name, when available.",
      +                              "type": [
      +                                "string",
      +                                "null"
      +                              ]
      +                            },
      +                            "component": {
      +                              "description": "Roslyn Workbench component that owns this frame.",
      +                              "enum": [
      +                                "Unknown",
      +                                "RoslynWorkbench",
      +                                "Roslyn",
      +                                "DotNet"
      +                              ],
      +                              "type": "string"
      +                            },
      +                            "file": {
      +                              "description": "First-party source file path recorded by symbols, when available.",
      +                              "type": [
      +                                "string",
      +                                "null"
      +                              ]
      +                            },
      +                            "line": {
      +                              "description": "One-based source line number, when available.",
      +                              "type": [
      +                                "integer",
      +                                "null"
      +                              ]
      +                            },
      +                            "method": {
      +                              "description": "Method name, when available.",
      +                              "type": [
      +                                "string",
      +                                "null"
      +                              ]
      +                            },
      +                            "type": {
      +                              "description": "Declaring type name, when available.",
      +                              "type": [
      +                                "string",
      +                                "null"
      +                              ]
      +                            }
      +                          },
      +                          "type": "object"
      +                        },
      +                        "type": "array"
      +                      },
      +                      "type": {
      +                        "description": "Exception type name.",
      +                        "type": "string"
      +                      }
      +                    },
      +                    "required": [
      +                      "type",
      +                      "message"
      +                    ],
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                },
      +                "executionFamily": {
      +                  "description": "Execution path used by the failed tool, such as server, plugin, or Code Action.",
      +                  "type": "string"
      +                },
      +                "expiresAt": {
      +                  "description": "Time at which this locally retained error record expires.",
      +                  "format": "date-time",
      +                  "type": "string"
      +                },
      +                "failureTime": {
      +                  "description": "Time at which the tool invocation failed.",
      +                  "format": "date-time",
      +                  "type": "string"
      +                },
      +                "operatingSystem": {
      +                  "description": "Operating system on which the server was running.",
      +                  "type": "string"
      +                },
      +                "pluginClassification": {
      +                  "description": "Plugin ownership classification when the failed tool was plugin-backed.",
      +                  "type": "string"
      +                },
      +                "processorArchitecture": {
      +                  "description": "Processor architecture of the server process.",
      +                  "type": "string"
      +                },
      +                "roslynVersion": {
      +                  "description": "Roslyn version used by the server.",
      +                  "type": "string"
      +                },
      +                "serverVersion": {
      +                  "description": "Roslyn Workbench server version that captured the failure.",
      +                  "type": "string"
      +                },
      +                "toolName": {
      +                  "description": "MCP tool that failed.",
      +                  "type": "string"
      +                },
      +                "workspace": {
      +                  "description": "Workspace context active during the failure, when available.",
      +                  "properties": {
      +                    "documentCount": {
      +                      "description": "Number of loaded documents at the time of failure.",
      +                      "type": "integer"
      +                    },
      +                    "lifecycleState": {
      +                      "description": "Workspace lifecycle state at the time of failure.",
      +                      "type": [
      +                        "string",
      +                        "null"
      +                      ]
      +                    },
      +                    "projectCount": {
      +                      "description": "Number of loaded projects at the time of failure.",
      +                      "type": "integer"
      +                    },
      +                    "transactionRevision": {
      +                      "description": "Active transaction revision at the time of failure, when applicable.",
      +                      "type": [
      +                        "integer",
      +                        "null"
      +                      ]
      +                    },
      +                    "workspaceEpoch": {
      +                      "description": "Workspace epoch active during the failure.",
      +                      "type": "integer"
      +                    },
      +                    "workspaceId": {
      +                      "description": "Server-generated identifier of the workspace active during the failure.",
      +                      "format": "uuid",
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": [
      +                    "object",
      +                    "null"
      +                  ]
      +                }
      +              },
      +              "required": [
      +                "correlationId",
      +                "failureTime",
      +                "expiresAt",
      +                "toolName",
      +                "executionFamily",
      +                "pluginClassification",
      +                "durationMilliseconds",
      +                "serverVersion",
      +                "roslynVersion",
      +                "dotNetVersion",
      +                "operatingSystem",
      +                "processorArchitecture"
      +              ],
      +              "type": "object"
      +            },
      +            "safeForExternalSubmission": {
      +              "description": "Whether the captured details are safe to submit outside the local process.",
      +              "type": "boolean"
      +            },
      +            "sensitivity": {
      +              "description": "Sensitivity classification applied to the captured error details.",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "error"
      +          ],
      +          "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"
      +      ],
      +      "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"
      +}
  2. First observedv1.0.2

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=false, and destructiveHint=false, so the safety profile is covered. The description adds value by disclosing that the result is temporary, may contain paths and user-authored identifiers, and must never be submitted externally—context that the annotations alone don't provide.

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?

The description is two concise sentences (plus a trailing phrase), front-loaded with the purpose before the sensitive-data caveat. It is efficient and meets the tool's complexity without unnecessary detail.

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

Completeness4/5

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

Given the single required parameter, full schema coverage, existing output schema, and annotations that establish the safety profile, the description is nearly complete. The only gap is that it doesn't differentiate itself from sibling tools that also deal with error reporting, but nothing essential to calling the tool correctly is missing.

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

Parameters3/5

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

There is only one parameter and schema description coverage is 100%; the schema already fully explains correlationId and its purpose. The description adds no additional parameter guidance beyond what the schema provides, so the baseline 3 for high schema coverage applies.

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

Purpose4/5

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

The description states a specific verb and resource: returns diagnostic details for a tool failure, keyed implicitly to a correlation ID. It's clear what the tool does but doesn't distinguish it from sibling tools like get-diagnostics or submit-error-report, which an agent might otherwise confuse for this retrieval operation.

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

Usage Guidelines3/5

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

The description implies a trigger ('unexpected tool failure') and a constraint ('intended only for the trusted local agent'), which gives some context, but it never states when to use it versus siblings such as submit-error-report or prepare-error-report. Usage is only lightly implied.

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