Skip to main content
Glama

get_guide

get_guide

Get data for a specific guide

Retrieves details of a specific guide. While the guide is being created, the endpoint returns 202 (poll again later). If the creation failed permanently (explicit terminal flag, or a failure older than 15 minutes with no retry left, see progressStatus.terminalInferred), it returns 200 with success=false, status=failed, a human-readable French error message, creationFailed=true, refunded (whether the consumed credits were automatically given back) and guide.progressStatus (raw reason, message, terminal). Stop polling in that case.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe ID of the guide to retrieve

TDQS

A3.8/5.0
Behavior5/5

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

With no annotations provided, the description carries the full burden and does so thoroughly. It discloses both transient creation state (202, poll again later) and permanent failure states (200 with success=false, status=failed, French error, creationFailed, refunded, progressStatus) and instructs agents to stop polling in the terminal case.

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

Conciseness3/5

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

The opening phrase 'Get data for a specific guide' largely duplicates the next sentence 'Retrieves details of a specific guide,' which is unnecessarily redundant. However, the rest of the description is dense and well-structured, covering important polling behavior without sprawling.

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?

The description is nearly complete for a single-parameter retrieval tool: it covers the asynchronous creation case, permanent failure detection, refund semantics, and progressStatus details. It does not specify the success response shape, but this is a minor omission for an operation with a simple get-by-id contract.

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?

The sole parameter id is fully documented in the input schema (100% coverage), and the description does not need to add parameter-specific semantics. It adds no extra detail beyond the schema, so a baseline score of 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 states a specific action (Get/Retrieves) and a specific resource (details of a specific guide), which clearly distinguishes it from the list-oriented sibling get_guides. It does not explicitly contrast itself with related getters, but the target resource is unambiguous.

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?

It gives strong operational guidance about when to poll again (202) and when to stop polling (terminal failure), but it does not explicitly say when to prefer this tool over alternatives like get_guides or other get_* tools. Usage context is implied rather than clearly contrasted.

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