Skip to main content
Glama
Sign In

GunSpec

by io.gunspec
OverviewDiscussionsAdmin

Read a GunSpec documentation guide

gunspec_read_docs
Read-onlyIdempotent

Returns one GunSpec documentation guide as Markdown. Pass the anchor of a section from gunspec_search_docs to read just that section, which is what an answer usually needs; omit it for the whole page, which can run to tens of kilobytes. Quote what this returns rather than paraphrasing from memory, and cite the url. Call gunspec_search_docs first unless the guide id is already known.

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": {
      "guide": "<guide>"
    },
    "name": "gunspec_read_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
guideYesThe guide id, e.g. "caching", "pagination", "errors" or "rate-limits".
anchorNoA section anchor from gunspec_search_docs. Omitted, the whole page is returned.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added
  2. Removed
  3. Added

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already indicate readOnly, idempotent, non-destructive behavior. The description adds useful context beyond annotations: the response is Markdown, whole pages can be tens of kilobytes, and returned content should be quoted with a URL citation. No contradiction with annotations.

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, each with a distinct job: what it returns, how to control page size, and how to use it correctly. It is front-loaded with the core definition and contains no filler.

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?

For a simple read tool with full schema coverage and safe annotations, the description is complete. It covers the return format, section anchoring, size warning, citation behavior, and prerequisite search step. Nothing essential is missing.

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?

Schema description coverage is 100%, so the schema already explains both parameters. The description reinforces the anchor behavior and the size implication, but adds little that is not already in the schema. Baseline 3 is appropriate.

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?

The description clearly states a specific verb and resource: it returns one GunSpec documentation guide as Markdown. It differentiates from sibling tools by mentioning gunspec_search_docs and by defining the guide/read relationship, so an agent can distinguish read vs search.

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

Usage Guidelines5/5

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

Explicitly instructs to call gunspec_search_docs first unless the guide id is already known, and explains when to pass an anchor versus omit it. It also gives a practical preference ('which is what an answer usually needs') and directs the agent to quote rather than paraphrase.

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

All GunSpec toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources