Skip to main content
Glama

Get Diagnostics

get-diagnostics
Read-onlyIdempotent

Retrieve compiler and analyzer diagnostics for a solution, project, or document, then filter by diagnostic ID or severity to inspect C# code issues.

Instructions

Returns compiler diagnostics and diagnostics from analysers referenced by the selected projects. Use this for general diagnostic inspection; use analyze-async for the additional bundled AsyncFixer rule set, or get-document-options to inspect document configuration. Omitted scope searches the loaded solution. Document scope keeps diagnostics whose primary source location belongs to that document; broader scopes can include findings without source locations. Requested diagnostic IDs and severities filter results before the default 200-diagnostic limit. Check diagnostics.hasMore before treating the report as complete.

Input Schema

NameRequiredDescriptionDefault
idsNoThe included diagnostic identifiers.
scopeNoThe optional scope selector.
workspaceNoProvide workspaceId, alias, path, or any combination.
severitiesNoThe included diagnostic severities.
diagnosticsLimitNoMaximum number of results to return.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv1.0.5
    • addedInput schema / $defs
      Added value: +{
      +  "project": {
      +    "properties": {
      +      "name": {
      +        "type": "string"
      +      },
      +      "path": {
      +        "description": "Workspace-relative path.",
      +        "type": "string"
      +      },
      +      "projectId": {
      +        "type": "string"
      +      },
      +      "targetFramework": {
      +        "type": "string"
      +      }
      +    },
      +    "type": [
      +      "object",
      +      "null"
      +    ]
      +  }
      +}
    • addedInput schema / properties / scope / properties / document / properties / project / $ref
      Added value: +"#/$defs/project"
    • removedInput schema / properties / scope / properties / document / properties / project / properties
      Removed value: -{
      -  "name": {
      -    "type": "string"
      -  },
      -  "path": {
      -    "description": "Workspace-relative path.",
      -    "type": "string"
      -  },
      -  "projectId": {
      -    "type": "string"
      -  },
      -  "targetFramework": {
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / scope / properties / document / properties / project / type
      Removed value: -[
      -  "object",
      -  "null"
      -]
    • addedInput schema / properties / scope / properties / project / $ref
      Added value: +"#/$defs/project"
    • removedInput schema / properties / scope / properties / project / properties
      Removed value: -{
      -  "name": {
      -    "type": "string"
      -  },
      -  "path": {
      -    "description": "Workspace-relative path.",
      -    "type": "string"
      -  },
      -  "projectId": {
      -    "type": "string"
      -  },
      -  "targetFramework": {
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / scope / properties / project / type
      Removed value: -[
      -  "object",
      -  "null"
      -]
    • addedInput schema / properties / scope / properties / projects / items / $ref
      Added value: +"#/$defs/project"
    • removedInput schema / properties / scope / properties / projects / items / properties
      Removed value: -{
      -  "name": {
      -    "type": "string"
      -  },
      -  "path": {
      -    "description": "Workspace-relative path.",
      -    "type": "string"
      -  },
      -  "projectId": {
      -    "type": "string"
      -  },
      -  "targetFramework": {
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / scope / properties / projects / items / type
      Removed value: -[
      -  "object",
      -  "null"
      -]
  2. 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": {
      +            "diagnostics": {
      +              "description": "The returned diagnostics.",
      +              "properties": {
      +                "hasMore": {
      +                  "description": "Whether additional items were available beyond this page.",
      +                  "type": "boolean"
      +                },
      +                "items": {
      +                  "description": "Items returned in this page.",
      +                  "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",
      +                    "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"
      +}
  3. First observedv1.0.2

TDQS

A4.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds real behavioral context: scope semantics (document scope keeps diagnostics whose primary source location belongs to that document; broader scopes can include findings without source locations), filter-before-limit ordering, the 200 default cap, and the hasMore truncation warning. That is above the annotation baseline but stops short of return-format or cost/latency detail, so a 3 is fair.

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

Conciseness5/5

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

Front-loaded with the core purpose, then alternatives, then scope semantics, then filtering/limit caveats. Every sentence carries information an agent would otherwise have to infer; nothing is repeated from the schema or annotations.

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?

An output schema exists, so return values needn't be described, yet the description still flags the one thing that matters operationally: check diagnostics.hasMore before treating the report as complete. With five optional parameters, 100% schema coverage, and a matching safety annotation set, nothing an agent needs in order to call it 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?

Schema coverage is 100%, so the baseline is 3. The description does add value beyond the schema by explaining that omitted scope means the loaded solution, how document scope narrows results, and that IDs/severities filter before the limit is applied — but it does not document the individual scope kinds or workspace selection beyond what the schema already states.

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 ('Returns compiler diagnostics and diagnostics from analysers referenced by the selected projects') and explicitly contrasts itself with two sibling tools, analyze-async and get-document-options. An agent can distinguish this from the many other analysis tools in the list 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 explicit routing rules: general diagnostic inspection goes here, AsyncFixer's bundled rule set goes to analyze-async, document configuration goes to get-document-options. It also names the alternative and the condition that selects it, plus the default scope when the parameter is omitted.

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