Skip to main content
Glama

Analyze Nullability

analyze-nullability
Read-onlyIdempotent

Reports CS86-prefixed nullable compiler diagnostics for a selected solution, project, document, or code span so you can pinpoint nullable-flow issues and validate fixes.

Instructions

Reports compiler diagnostics whose IDs begin with CS86 for focused nullable analysis. Use get-diagnostics for other compiler or project analyser findings, and get-document-options to inspect project-level nullable context. A supplied location overrides scope and keeps diagnostics intersecting its resolved span; echo its expectedSnapshot. Without a location, searches the selected scope or the loaded solution by default. Findings depend on compiler settings and are limited to 50 by default; check findings.hasMore.

Input Schema

NameRequiredDescriptionDefault
scopeNoSelects documents or projects to analyse when location is omitted; omitted searches the loaded solution. Ignored when location is supplied.
locationNoProvide exactly one of span or selection.
workspaceNoProvide workspaceId, alias, path, or any combination.
findingsLimitNoCaps returned nullable-flow diagnostics. Omitted or null uses 50; zero returns no findings.
expectedSnapshotNoEcho the snapshot returned with the data or transaction state used to construct this request.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed16 schema fields changedv1.0.5
    • addedInput schema / $defs
      Added value: +{
      +  "document": {
      +    "properties": {
      +      "documentId": {
      +        "description": "Workspace-local document ID.",
      +        "type": "string"
      +      },
      +      "path": {
      +        "description": "Workspace-relative path.",
      +        "type": "string"
      +      },
      +      "project": {
      +        "$ref": "#/$defs/project",
      +        "description": "Disambiguates documents with matching paths or IDs."
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "project": {
      +    "properties": {
      +      "name": {
      +        "type": "string"
      +      },
      +      "path": {
      +        "description": "Workspace-relative path.",
      +        "type": "string"
      +      },
      +      "projectId": {
      +        "type": "string"
      +      },
      +      "targetFramework": {
      +        "type": "string"
      +      }
      +    },
      +    "type": [
      +      "object",
      +      "null"
      +    ]
      +  }
      +}
    • addedInput schema / properties / location / properties / selection / properties / document / $ref
      Added value: +"#/$defs/document"
    • removedInput schema / properties / location / properties / selection / properties / document / properties
      Removed value: -{
      -  "documentId": {
      -    "description": "Workspace-local document ID.",
      -    "type": "string"
      -  },
      -  "path": {
      -    "description": "Workspace-relative path.",
      -    "type": "string"
      -  },
      -  "project": {
      -    "$ref": "#/properties/scope/properties/document/properties/project",
      -    "description": "Disambiguates documents with matching paths or IDs."
      -  }
      -}
    • removedInput schema / properties / location / properties / selection / properties / document / type
      Removed value: -"object"
    • addedInput schema / properties / location / properties / span / properties / document / $ref
      Added value: +"#/$defs/document"
    • removedInput schema / properties / location / properties / span / properties / document / properties
      Removed value: -{
      -  "documentId": {
      -    "description": "Workspace-local document ID.",
      -    "type": "string"
      -  },
      -  "path": {
      -    "description": "Workspace-relative path.",
      -    "type": "string"
      -  },
      -  "project": {
      -    "$ref": "#/properties/scope/properties/document/properties/project",
      -    "description": "Disambiguates documents with matching paths or IDs."
      -  }
      -}
    • removedInput schema / properties / location / properties / span / properties / document / type
      Removed value: -"object"
    • 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": {
      +            "findings": {
      +              "description": "The returned findings.",
      +              "properties": {
      +                "hasMore": {
      +                  "description": "Whether additional items were available beyond this page.",
      +                  "type": "boolean"
      +                },
      +                "items": {
      +                  "description": "Items returned in this page.",
      +                  "items": {
      +                    "properties": {
      +                      "diagnostic": {
      +                        "description": "The projected diagnostic.",
      +                        "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",
      +                          "null"
      +                        ]
      +                      }
      +                    },
      +                    "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. Changed2 schema fields changedv1.0.3
    • addedInput schema / properties / findingsLimit / description
      Added value: +"Caps returned nullable-flow diagnostics. Omitted or null uses 50; zero returns no findings."
    • addedInput schema / properties / scope / description
      Added value: +"Selects documents or projects to analyse when location is omitted; omitted searches the loaded solution. Ignored when location is supplied."
  4. First observedv1.0.2

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already cover the readOnly/idempotent/non-destructive profile, and the description still adds real behavior: CS86-only filtering, findings depend on compiler settings, a default 50-cap with zero meaning empty, the findings.hasMore signal, and the requirement to echo expectedSnapshot. The only gap is what happens if the snapshot mismatches (error vs. silent refresh), which is left implicit.

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?

Five compact sentences, each load-bearing: purpose, alternatives, location precedence, default scope, then limits/pagination. The distinguishing filter and sibling routing are front-loaded with no filler.

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, five-optional-parameter query tool with an output schema and full annotation coverage, the description supplies everything an agent needs: what is filtered, how scope vs. location resolve, the default limit, and how to detect truncation.

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, but the description adds precedence semantics not obvious from the schema: a supplied location overrides scope and keeps only diagnostics intersecting its resolved span, and an omitted location searches the selected scope or the loaded solution. It does not elaborate on span/selection construction, but the schema covers that.

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?

"Reports compiler diagnostics whose IDs begin with CS86 for focused nullable analysis" gives a specific verb, resource, and a stated filter (CS86 codes) that separates it from the generic diagnostics siblings. An agent can tell it apart from get-diagnostics without opening either 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?

It explicitly routes the agent elsewhere: get-diagnostics for other compiler/analyser findings and get-document-options for project-level nullable context. The location-vs-scope precedence rule is also stated, leaving little to infer.

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