Skip to main content
Glama

get_doc

Fetch a repo's full README/documentation as Markdown.

Input Schema

NameRequiredDescriptionDefault
repoYesrepo slug, e.g. 'cli', 'togo', 'ui'

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It usefully discloses the return format (Markdown), but says nothing about auth requirements, what happens for an unknown/renamed repo, or whether large docs are truncated — meaningful gaps for a fetch tool with zero annotation coverage.

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?

One short sentence, front-loaded with the verb and resource, with zero filler. Nothing could be removed without losing information.

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

Completeness4/5

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

For a single-parameter read tool with no output schema, the description covers what it fetches and the format returned, which is nearly sufficient. The remaining omission is failure behavior for a missing repo, which is minor.

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% and the single 'repo' parameter already documents the slug format with examples. The description's phrase 'a repo's' confirms the parameter's role but adds no syntax or constraint beyond the schema, so the baseline 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?

States a specific verb ('Fetch'), resource ('repo's full README/documentation') and output format ('as Markdown'), so the action is unambiguous. It does not explicitly differentiate itself from the sibling search_docs, though 'full' implies a contrast with search results.

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 only implied: 'full ... documentation' suggests this is for retrieving an entire repo's docs rather than searching snippets, which distinguishes it loosely from search_docs. No explicit when-to-use, when-not, or named alternatives are given, and no relationship to framework_overview is stated.

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.