jenkins_get_job

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

No annotations are provided, so the description carries full burden. It only explains path formatting but omits behavioral traits like authentication requirements, error handling, side effects, or response details. For a read-only retrieval tool, more transparency is needed.

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 two concise sentences with no unnecessary words. It front-loads the core purpose and immediately provides the key usage detail about nested paths.

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 minimal parameter documentation and lack of explanation for the 'tree' parameter or return value format, the description is incomplete. Even though an output schema exists, the description should provide more context for a retrieval tool with an optional filter parameter.

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?

The description adds value to the 'job' parameter by explaining it can be a slash-separated string or a list of path components, which is not in the schema. However, it fails to explain the 'tree' parameter at all, and schema coverage is 0%, so the description only partially compensates.

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 retrieves a single job by Jenkins job path, using 'Get one job' which specifies both verb and resource. The mention of nested paths using slash-separated names or a list adds precision and differentiates from sibling tools like jenkins_list_jobs.

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 implies usage for retrieving a single job, but does not explicitly state when to use this tool versus alternatives, nor does it provide when-not-to-use conditions or list sibling tools for comparison.

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