Skip to main content
Glama

docs-get_repo_doc

Fetch a specific markdown document from a repository's docs directory using the repo name and relative path. Use it to retrieve known documentation files by path.

Instructions

Fetch a specific markdown document from <repo>/docs/<path>. Use docs-list_repo_docs to discover valid paths.

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": {
      "repo": "<repo>",
      "path": "<path>"
    },
    "name": "docs-get_repo_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesPath relative to `<repo>/docs/`, e.g. 'subsystems/bootstrap.md'.
repoYesRepo name (e.g. 'exeris-kernel'). Must match /^exeris-[a-z0-9][a-z0-9-]*$/.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.9.0

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full behavioral burden. 'Fetch' implies a read, which is useful, but it says nothing about what happens when the path does not exist, whether the full document text is returned, or any size/pagination limits. For a simple read tool this is adequate but thin.

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 sentences, zero filler, with the resource location front-loaded and the discovery hint trailing. Every clause earns its place.

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 two-parameter read tool with fully described parameters and no output schema, the definition covers location semantics and path discovery adequately. The only real omission is the return shape/error behavior, which is a minor gap for this complexity level.

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 documented, including the repo regex and the path example. The description only reinforces the `<repo>/docs/<path>` composition, adding little beyond the schema. A baseline 3 is appropriate.

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 uses a specific verb (Fetch) with a specific resource (a markdown document) and pins down the location as `<repo>/docs/<path>`. That is enough to distinguish it from search- or list-shaped siblings. It does not, however, contrast itself with the other single-document fetchers in the family (docs-get_adr, docs-get_hla, docs-get_template), so an agent must infer when a doc is a repo doc versus an ADR/HLA.

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?

It gives concrete routing guidance for the main failure mode: use `docs-list_repo_docs` to discover valid paths rather than guessing. There is no explicit when-not or prerequisite statement, but for a simple read-only fetch the context is clear enough to act on.

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