Skip to main content
Glama
PROMPTEYE-SP-Z-O-O

prompteye-mcp

Official

Read one topical map

get_topical_map
Read-only

Retrieves a finished topical map by ID, returning its pillar page and all cluster articles grouped by category so editors can audit coverage and find topic gaps.

Instructions

One map in full: its pillar page and every cluster article, grouped by category. Call it after create_topical_map until status is ready — pillar is null and clusters is empty until then, and errorMessage is set instead if generation failed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
mapIdYesId of the map, as create_topical_map or list_topical_maps reports it.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
topicYes
pillarYesThe compendium page. null until ready.
statusYesprocessing the moment it is requested, then ready — pillar and clusters filled in — or error, see errorMessage.
clustersYesThe supporting article titles, grouped by category. Empty until ready.
languageYes
createdAtYesWhen the map was requested, ISO 8601 in UTC.
projectIdYes
errorMessageYesWhy generation failed. null unless status is error.
generationCostYesCost of the generation, in USD.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.0.22

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds genuinely useful lifecycle behavior beyond that: `pillar` is null and `clusters` empty until generation completes, and `errorMessage` is set on failure. It stops short of noting rate limits or how long readiness typically takes, so it is strong but not exhaustive.

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 tight sentences: the first front-loads what the tool returns, the second front-loads the usage trigger. Zero filler and no restatement of the title or name.

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, yet the description still supplies the state semantics an agent actually needs (empty-until-ready, error sentinel) rather than duplicating field lists. Combined with the 100%-covered single param and read-only annotations, nothing needed to call this correctly is missing.

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% and the single parameter is fully documented in the schema itself, including provenance ('as create_topical_map or list_topical_maps reports it'). The description adds no syntax or format detail beyond that, so baseline 3 is 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?

Opens with a specific verb+resource+scope: 'One map in full: its pillar page and every cluster article, grouped by category.' This distinguishes it from list_topical_maps (which enumerates maps) and from the mutation siblings create/regenerate, so an agent can route correctly without opening the 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?

Explicitly states when to call it ('after create_topical_map until status is ready') and names the alternative condition — once ready, stop polling. The sequencing dependency and the stop condition are both spelled out, leaving nothing to inference.

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