atlas-brief-mcp

Overview Schema Source Related Servers Discussions Admin

atlas_read

Read-onlyIdempotent

Read a specific documentation section by anchor and fetch its Markdown content with character-offset pagination for long sections.

Instructions

Read the Markdown content of a single documentation section by its anchor with character-budget pagination.

Use this tool after obtaining an `anchor` from `atlas_where`, `atlas_search`, or `atlas_outline`.
Never read raw documentation files from disk when `atlas_read` can fetch the exact section.

Behavior & Output:
- Read-only lookup from the local documentation index.
- Returns a JSON string `{anchor, heading, path, lines, content, truncated, next_offset}`.
  If the anchor does not exist, returns `{error, suggestions}` with the closest valid anchors.

Input Schema

Name	Required	Description
`anchor`	Yes	Section anchor identifier in `<doc_id>#<section-slug>` format (or `<doc_id>` for the document root), as returned by `atlas_where`, `atlas_search`, or `atlas_outline` (e.g. 'combat#damage-model').
`offset`	No	Character offset to start reading from (default 0). When a previous call returned `truncated: true`, pass its `next_offset` value here to read the next page.
`max_chars`	No	Maximum number of characters to return in one call (default 3000).

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed7 schema fields changedv0.1.1Nov 6, 2026

addedInput schema / properties / anchor / description

Added value: +"Section anchor identifier in `<doc_id>#<section-slug>` format (or `<doc_id>` for the document root), as returned by `atlas_where`, `atlas_search`, or `atlas_outline` (e.g. 'combat#damage-model')."

addedInput schema / properties / anchor / minLength
```
Added value: +1
```

addedInput schema / properties / max_chars / description

Added value: +"Maximum number of characters to return in one call (default 3000)."

addedInput schema / properties / max_chars / maximum
```
Added value: +50000
```
addedInput schema / properties / max_chars / minimum
```
Added value: +100
```

addedInput schema / properties / offset / description

Added value: +"Character offset to start reading from (default 0). When a previous call returned `truncated: true`, pass its `next_offset` value here to read the next page."

addedInput schema / properties / offset / minimum
```
Added value: +0
```

First observedv0.1.0Nov 5, 2026

TDQS

A4.7/5.0

Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint=false and destructiveHint=false, so safety is covered structurally. The description adds genuinely useful behavior the annotations cannot express: the read is from a local index, the success payload carries `truncated`/`next_offset` for pagination chaining, and a missing anchor yields `{error, suggestions}` rather than a bare failure. Minor redundancy is recounting the return keys, which the output schema already supplies.

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?

It is front-loaded with the core action, follows with a routing rule, then a short labeled behavior block. Every line carries information an agent needs: there are no filler adjectives or repetition of the title.

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?

An output schema exists, so return values need not be fully explained, yet the description still covers the error path and pagination continuation, the two cases an agent must handle. For a three-parameter read tool, nothing material is left unspecified.

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 schema already defines anchor, offset and max_chars in detail, which sets the baseline at 3. The description adds meaning beyond it by framing max_chars as a character budget and describing the offset/next_offset handoff across calls, though it does not restate the anchor's `<doc_id>#<section-slug>` format, which only the schema carries.

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 opens with a specific verb+resource: 'Read the Markdown content of a single documentation section by its anchor', and immediately scopes it with 'single' and 'character-budget pagination'. That distinguishes it cleanly from atlas_search (discovery), atlas_outline (structure), and atlas_where (locating anchors) without requiring the agent to open any other schema.

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?

It states the precondition explicitly ('Use this tool after obtaining an anchor from atlas_where, atlas_search, or atlas_outline') and adds a negative guideline ('Never read raw documentation files from disk when atlas_read can fetch the exact section'). Both the when and the when-not are present, which is rare and directly actionable.

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

Deploy Server