Skip to main content
Glama

Get the fix instructions for a finding

fix_prompt
Read-onlyIdempotent

Return everything needed to fix one finding in the repository: the rule, the affected URL, the evidence, and a framework-aware instruction written for a coding assistant (devPrompt, in the site's language). When the same rule is open on other pages of the URL's template, template gives the template and how many of its pages have it. guidance is the official documentation the rule rests on, effort a rough size of the fix (minutes, hours or days), and convention is true when the rule is common practice rather than a search engine requirement.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
findingIdYesFrom findings_list, or fix_first's sampleFindingId.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / findingId / description
      Previous value: -"From findings_list."New value: +"From findings_list, or fix_first's sampleFindingId."
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover readOnly, idempotent and non-destructive behavior, so the bar is lower. The description adds substantial context beyond them by explaining what the response contains, including that devPrompt is written for a coding assistant in the site's language and that template reports open instances across a template's pages.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is front-loaded with the core purpose, then defines each returned field in compact clauses. It is dense and long-ish, but each clause maps to a distinct returned field and earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, so the description carries the full burden of explaining return values, and it does so field by field (devPrompt, template, guidance, effort, convention). Combined with annotations covering the safety profile, an agent has what it needs to call this correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There is a single parameter with 100% schema description coverage, and the schema already says the findingId comes from findings_list or fix_first's sampleFindingId. The description adds no further parameter semantics, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: 'Return everything needed to fix one finding in the repository,' and enumerates the returned payload (rule, URL, evidence, devPrompt, template, guidance, effort, convention). This distinguishes it from findings_list (which enumerates findings) and fix_first, though it does not name those siblings directly in the description text.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied by the purpose (fetch fix instructions for one finding), and the schema points to findings_list and fix_first as sources of findingId. However, the description itself gives no explicit when-to-use, prerequisites, or alternatives, so the agent must infer the workflow.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.