Skip to main content
Glama

Read documentation

read_docs

Reads README and docs files from a local checkout or GitHub repo to gather documentation content for auditing. Use after fetching repo structure to verify docs against the actual codebase.

Instructions

Read README and docs/* from a local path or GitHub repo. Call after fetch_repo_structure.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "read_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoAbsolute or relative local path to a git checkout
githubNoGitHub repo as owner/repo or https://github.com/owner/repo (public repos via GitHub API)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A3.7/5.0
Behavior3/5

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

No annotations exist, so the description carries the full behavioral burden; it does convey that the operation is a read of documentation files and that a prior structure fetch is expected. It says nothing about what happens when both path and github are supplied, when neither is supplied (both parameters are optional), or about private-repo limits — the schema mentions public-repo-only API access but the description does not reinforce it.

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?

Two short sentences, front-loaded with the core action and scope, followed by the prerequisite. No filler or redundant restatement of the title.

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

Completeness3/5

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

For a two-parameter, unannotated, no-output-schema tool, the description covers purpose and ordering but leaves an important ambiguity: with zero required parameters, an agent is not told whether one of path/github must be provided or what happens if both or neither are. Otherwise adequate for the tool's modest complexity.

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 both parameters are already fully documented, establishing a baseline of 3. The description's "local path or GitHub repo" phrasing mirrors what the schema already states and adds no format, precedence, or mutual-exclusivity rules.

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 gives a specific verb ("Read") and a precise resource scope ("README and docs/*"), and names both supported sources (local path or GitHub repo). It is distinguishable from apply_doc_patches and fetch_repo_structure, though it never explicitly contrasts itself with the writer sibling.

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?

"Call after fetch_repo_structure" supplies an explicit prerequisite and ordering cue, which is real usage guidance absent from the schema. It stops short of stating when not to use it or how to choose between the two source modes, so it is clear context without exclusions.

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