Skip to main content
Glama
Sign In
atlas-brief-mcp

atlas-brief-mcp

by drproof
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

atlas_outline

Read-onlyIdempotent

Returns a hierarchical table of contents of indexed documentation so you can explore project structure, browse headings, and locate section anchors for reading when keyword searches miss.

Instructions

Return the hierarchical table of contents (headings and section anchors) across indexed documentation.

Use this tool when exploring an unfamiliar project structure, browsing available documents,
or when keyword searches (`atlas_where` / `atlas_search`) did not match your query terms.

Behavior & Output:
- Read-only, side-effect-free query of indexed document headings.
- Returns a JSON string `{doc, outline, truncated}` where `outline` lists each heading level,
  title, and `anchor` ready for `atlas_read`.

Input Schema

NameRequiredDescriptionDefault
docNoOptional document ID (e.g. '02-combat' or 'architecture') to list headings for a single document. Omit or pass null to list the table of contents for all documents.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.1
    • addedInput schema / properties / doc / description
      Added value: +"Optional document ID (e.g. '02-combat' or 'architecture') to list headings for a single document. Omit or pass null to list the table of contents for all documents."
  2. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, non-destructive behavior, but the description still adds value by describing the return envelope {doc, outline, truncated} and that anchors are directly usable with atlas_read. It stops short of explaining when 'truncated' becomes true or how to handle it, which is the main remaining gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded purpose followed by usage and output sections; the structure is easy to scan. The 'Read-only, side-effect-free' bullet partially restates annotations and could be trimmed, but overall wording 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?

Covers what the tool returns, how to use anchors downstream, and when to prefer it, which is more than sufficient for a single-optional-param read tool with an output schema. The unexplained truncation semantics are the only notable omission.

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 coverage is 100% with a thorough 'doc' description including example IDs and the null/omit behavior, so the schema does the heavy lifting. The description adds nothing about the single parameter, making the baseline 3 correct.

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?

States a specific verb and resource ('Return the hierarchical table of contents (headings and section anchors) across indexed documentation') and scopes it to indexed docs, which separates it from retrieval siblings like atlas_read and atlas_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 names three situations (unfamiliar project structure, browsing available docs, keyword searches via atlas_where/atlas_search that failed) and names the alternative tools, so an agent can decide between outline and search without opening schemas.

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

Deploy Server

Other Tools