jenkins_get_json

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

No annotations are provided, so the description must cover behavioral traits. It discloses that the tool performs a GET (implying read-only) and rejects external URLs and traversal, but does not describe response format, error handling, or any side effects. Basic transparency but incomplete.

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?

The description is extremely concise with two sentences, no redundant information, and no unnecessary details. Every word earns its place.

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?

Given the low schema coverage (0%), no annotations, and the existence of an output schema, the description lacks sufficient detail. It fails to explain the tool's output, error scenarios, or how to use parameters like 'query'. The agent would likely need to infer or guess several aspects.

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?

With 0% schema description coverage, the description should compensate. It clarifies that the 'path' parameter is a relative path and the 'query' parameter is absent from the description entirely. The description adds minimal meaning beyond the schema field names.

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?

The description clearly states the tool performs a GET request on a relative Jenkins JSON API path, which is specific and distinguishes it from sibling tools that target particular Jenkins functions.

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?

The description mentions it 'rejects external URLs and traversal,' providing a security constraint, but lacks guidance on when to use this generic tool versus the many specific sibling tools (e.g., jenkins_get_job). No explicit alternatives or usage context.

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