getBuildScm

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

Description confirms read-only behavior ('Retrieves'), aligning with readOnlyHint annotation, but adds no further behavioral details such as authentication requirements, potential performance impact, or limitations on the returned data.

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?

Single sentence with no fluff, but could be more structured. It is concise and front-loaded, though slightly too minimal.

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?

No output schema exists, yet the description does not explain what the returned SCM configurations contain or their format. For a retrieval tool, this is a significant gap, especially given the number of sibling tools.

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?

Schema coverage is 100%, so the schema already documents both parameters. The description adds no extra meaning beyond what the schema provides, meeting the baseline for high coverage.

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 SCM configurations of a Jenkins build, with a specific verb and resource. It distinguishes from siblings like getJobScm (job-level) and getBuildChangeSets (changesets).

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?

No explicit guidance on when to use this tool vs alternatives like getJobScm or getBuildChangeSets. The description implies it's for build-level SCM configs but does not clarify context or exclusions.

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