Skip to main content
Glama

Analyze Nullability

analyze-nullability
Read-onlyIdempotent

Detects nullable-flow diagnostics across a solution, project, document, or selected code to reveal possible null dereferences and related warnings.

Instructions

Returns nullable-flow diagnostics for a selected scope or location.

Input Schema

TableJSON 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

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": {
      +            "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"
      +}
  2. 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."
  3. First observedv1.0.2

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety and repeatability profile is fully covered. The description adds only the output type ('nullable-flow diagnostics') and does not disclose result shape, ordering, or how findingsLimit truncation behaves, though the output schema presumably carries return details.

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?

A single front-loaded sentence with zero filler; the resource ('nullable-flow diagnostics') is stated immediately. It is lean to the point of being terse, but nothing is wasted or buried.

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

Completeness3/5

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

With an output schema present and annotations covering the safety profile, the description need not explain return values. Still, for a tool with five nested, optional parameters and a rich sibling set, one sentence leaves the agent to infer the scope-vs-location precedence and the family boundaries from the schema alone.

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 description coverage is 100%, so the schema already documents scope, location, workspace, findingsLimit, and expectedSnapshot in detail. The description adds no parameter-level meaning beyond that, so the baseline 3 is appropriate.

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?

States a specific verb and resource: 'Returns nullable-flow diagnostics'. This is more precise than the title and tells the agent it is about nullability analysis rather than general diagnostics. However, it does not distinguish itself from siblings like get-diagnostics or the other analyze-* tools (analyze-data-flow, analyze-async), so the agent must infer the boundary.

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?

'for a selected scope or location' implies the operating context and matches the scope/location parameters, giving implied usage. But there is no explicit when-to-use vs get-diagnostics or analyze-data-flow, and no when-not-to-use or prerequisite guidance, so routing between the analyze-* family is left to inference.

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