定位 Jenkins Job

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds meaningful behavioral context by stating what is returned: 'Job 名、Jenkins 当前配置分支、仓库地址和链接' (job name, current branch, repo URL, link). This goes beyond the annotation and clarifies the output nature.

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 that front-loads the verb and resource. No redundant words or filler. It efficiently communicates the tool's purpose and result in one line.

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?

As a simple read-only lookup tool with two parameters and no output schema, the description adequately covers what the tool does and what it returns. It does not mention potential edge cases like multiple results or empty results, but for this scope it is sufficiently complete.

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 description coverage is 100%: both 'repo' and 'env' have descriptions. The tool description does not add additional parameter semantics beyond the schema; it simply restates the overall purpose. Baseline of 3 is appropriate since the schema carries full weight.

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 uses a specific verb '定位' (locate/find) with a clear resource: 'Jenkins HOT/QAT/QAT2 候选 Job' by GitLab repository. It clearly distinguishes from siblings like 'deploy' and 'get_status' by focusing on locating candidate jobs rather than deploying or checking status.

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: when you need to locate Jenkins jobs for a GitLab repo, use this tool. It mentions optional environment filtering, but does not explicitly state when to use this tool versus alternatives like 'get_status' or 'deploy'. No exclusions or alternative guidance is provided.

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