Skip to main content
Glama

App Finishers fix guides

Read a fix guide

get_guide
Read-onlyIdempotent

Read one fix guide: the causes, how to check which one applies, and the fix for each, step by step. Use a slug from lookup_error or list_guides. By default it returns the whole guide; to save tokens, set outline to true to get only its numbered sections, then pass section to read just one.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "slug": "<slug>"
    },
    "name": "get_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesThe guide's slug, e.g. supabase-new-row-violates-row-level-security-policy
outlineNoOnly the title, summary and numbered section headings.
sectionNoOnly this section, by its number in the outline.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so safety is covered. The description adds real behavioral context the annotations cannot: what the response contains (causes, checks, fixes), the default full-guide payload, and the token-saving outline/section modes. It does not mention pagination or size limits, but for a read-only lookup the disclosure is solid.

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

Conciseness5/5

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

Three sentences, front-loaded with purpose, then source of slug, then the progressive-disclosure options. Every clause carries usable information; nothing is repeated from the title or schema.

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?

With no output schema, the description compensates by describing the shape of the returned guide and its reading modes. For a three-parameter read tool, an agent has everything needed to call it correctly on the first try.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, and the description earns more by explaining the coupling between parameters: outline returns only numbered section headings, and section takes a number from that outline. That sequencing meaning is not obvious from the schema alone.

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

Purpose5/5

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

States a specific verb (Read) and resource (one fix guide) plus the content it returns: causes, how to check which one applies, and the fix step by step. It also routes the agent to the sibling tools that produce valid slugs (lookup_error, list_guides), so it is distinguishable without opening a schema.

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

Usage Guidelines4/5

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

Gives a clear entry condition (use a slug from lookup_error or list_guides) and explicit mode-selection guidance: default for the whole guide, outline=true to save tokens, then section to read one part. It lacks a 'when not to use this' statement, but the alternatives and conditions are otherwise concrete.

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.

Resources