Skip to main content
Glama

get_outline

get_outline

Get generated page structure for a guide

Retrieves the generated page structure (flat heading list) for a guide.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
guideIdYesID of the guide

TDQS

A4/5.0
Behavior4/5

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

Without annotations, the description carries full burden. It explicitly states 'Retrieves' and describes the output, implying a read-only operation. No contradictions or hidden behaviors.

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?

The description is two sentences, front-loaded with the key action. It is efficient, though the first line is nearly redundant with the title. No wasted words.

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?

Given the tool simplicity (1 param, no output schema), the description fully explains what it does and what it returns. Sibling differentiation is clear.

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 guideId described. The description adds 'for a guide' which reinforces the parameter's role but adds no new semantic meaning beyond the schema.

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 clearly states the tool retrieves the generated page structure (flat heading list) for a guide, distinguishing it from siblings like create_outline and delete_outline.

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?

The description does not provide explicit guidance on when to use this tool versus alternatives, nor does it mention when not to use it. Usage is implied by the 'get' prefix, but lacks direct comparison.

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.

TDQS

B3.4/5.0
Disambiguation4/5

Most tools target distinct resources (guides, eeat, intent, internal_links, meta, outline, score, credits, tokens). However, some pairs like create_eeat and create_eeat_competitors are very similar and could cause confusion, though their descriptions clarify the difference.

Naming Consistency4/5

Tools consistently use a verb_noun pattern (create_, get_, delete_). Minor inconsistencies include 'get_aissistant_tokens' (typo) and 'get_credit_ledger' (singular vs plural), but overall the pattern is clear.

Tool Count4/5

28 tools is on the higher end but justifiable for a comprehensive SEO analysis platform covering guides, multiple AI features, EEAT, credits, and tokens. A few tools could be merged (e.g., get_credits and get_aissistant_tokens), but the count is still reasonable.

Completeness4/5

The tool surface covers CRUD for guides and most AI features, plus token/credit management. A notable gap is the lack of a get_score tool after create_score, and some features like updating EEAT analysis are absent. Overall, the core workflows are supported.

Resources