Introspect the Tenable OT GraphQL schema

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

Discloses read-only nature and that it touches no OT data. Also explains that the server does not guess enum values, which can cause silent failures, and the default behavior of dumping types the server still needs.

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

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

Well-structured with a concise purpose sentence, a rationale section, and bullet-point parameter explanations. Every sentence earns its place, and key information is front-loaded.

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

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

For a 3-parameter introspection tool, the description covers purpose, usage, parameters, safety, and the context of why the tool exists. The output schema covers return values, so no critical information is missing.

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

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

Explains each parameter in plain language, including the default of type_names when omitted. This fully compensates for the 0% schema description coverage and adds meaning beyond the raw schema.

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

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

Clearly states the tool reads the deployment's own GraphQL schema, listing enum values, input-object shapes, and root fields. This is a specific verb+resource and distinguishes the tool from sibling data-query tools.

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

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

Provides explicit use cases: resolving SchemaNotConfirmedError by dumping required types, and checking if the appliance exposes a top-level query. Tells the agent exactly when to call with no arguments and unblocks gated filters.

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