frontend_security_audit_ci_pipeline

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

With no annotations provided, the description carries full burden. It discloses that the tool is read-only, idempotent, and that certain references (${{ secrets.FOO }}) are not flagged. This adds valuable behavioral context beyond the tool name. However, it does not mention rate limits, authentication requirements, or error handling.

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 moderately sized and front-loaded with the core purpose. Each sentence adds value, though the note about report_feedback could be more concise. Overall, it earns its length.

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 tool's simplicity (2 parameters, no nested objects), the description adequately covers return values (risk_level, findings list with severity and line hints). With an output schema existing (as per context), the description doesn't need to detail return fields fully, but provides sufficient context for an agent to understand the tool's output.

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 explains both parameters: config (required, 500 KB max, raw YAML/TOML) and config_type (enum with defaults and descriptions of behavior per type: github_actions full checks, vercel/netlify secrets only in Sprint 8). This adds meaning beyond the schema's enum list, clarifying constraints and behavioral scope.

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 scans CI configs from GitHub Actions, Vercel, or Netlify for specific security issues (exposed secrets, missing lockfile enforcement, unpinned dependencies). It uses a specific verb ('Scan') and resource ('CI configs'), and is distinct from sibling tools like frontend_security_audit_manifest which scan manifest files.

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 explains that users should paste config content and not require filesystem access, but does not explicitly state when to use this tool over alternatives (e.g., frontend_security_audit_manifest). It does provide a fallback instruction to use report_feedback if the response doesn't serve the user's need, which is helpful but not a substitute for direct usage guidance.

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