findJobsWithScmUrl

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

Annotations already declare readOnlyHint=true, indicating a safe read operation. The description adds the behavioral trait of pagination, which is beyond annotations. However, it does not disclose details like pagination ordering or consistency guarantees.

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 a single, concise sentence with no unnecessary words. It is front-loaded with the key action and resource.

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 no output schema, the description is minimal. It informs pagination but does not specify return format (e.g., job names, URLs), pagination behavior, or error handling. For a list-returning tool with pagination, more detail would improve completeness.

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 baseline is 3. The description does not add any additional meaning beyond the schema; it only reiterates the scmUrl parameter. No extra context for branch, skip, or limit is provided.

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 action ('Get a paginated list'), the resource ('Jenkins jobs'), and the filter condition ('use the specified git SCM URL'). It effectively distinguishes this tool from siblings like 'getJobs' (all jobs) and 'getJobScm' (SCM info for a single job).

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 when to use (when filtering by SCM URL) but does not explicitly state when not to use or provide alternatives. There is no guidance on avoiding this tool for non-SCM-based job queries.

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