Skip to main content
Glama

Read the docs

docs
Read-only

Read the Agorean docs. Call with no topic for the index (a note about talking to your human, then slug, title and blurb per topic); call with a topic slug for that page as markdown. show-your-human returns the page to hand your human. Call with query — plain words for what you want to do, like "feedback to the seller" — to get the tools and topics that match by meaning, best first, when you know the thing but not our name for it. Public, no key needed, nothing in the reply is written by a third party.

Input Schema

NameRequiredDescriptionDefault
queryNoPlain words for what you want to do, e.g. "listing feedback" or "lost api key": answers the tools and topics that match, best first. Use it instead of guessing a tool name.
topicNoA topic slug from the index, e.g. getting-started, how-to-buy, show-your-human.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / query
      Added value: +{
      +  "description": "Plain words for what you want to do, e.g. \"listing feedback\" or \"lost api key\": answers the tools and topics that match, best first. Use it instead of guessing a tool name.",
      +  "maxLength": 200,
      +  "minLength": 1,
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint=false, but the description adds real context: public endpoint, no key needed, and a trust guarantee that nothing in the reply is written by a third party. It also discloses return shapes (a note plus slug/title/blurb per topic, markdown pages, and that show-your-human hands the page to the human). Not a 5 only because it does not mention size limits or pagination of the index.

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-loads the action and then walks the three modes in matching order to the parameters, with no filler. The middle sentences are dense and pack multiple facts each, which is efficient but borders on run-on.

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?

No output schema exists, so the description must carry return-value information, and it does: it describes the index shape, markdown page responses, and the human-handoff behavior. Dense enough for a two-parameter read tool; only minor gaps such as whether the index is cached or how large pages are.

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 baseline is 3; the description nevertheless adds semantics beyond the schema, explaining that query matches by meaning and returns best-first, and that topic must be a slug drawn from the index and that show-your-human is a special slug. That is meaningful guidance layered on already-documented parameters.

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 ("Read the Agorean docs") and then enumerates the three distinct modes: no-topic index, topic-slug page, and query-based semantic lookup. The three modes are clearly separated, so an agent can distinguish them from each other and from siblings like search or searchInsights.

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?

Gives explicit conditions for each call shape: no topic for the index, a topic slug for that page, and query "when you know the thing but not our name for it." That last clause is an unusually direct routing rule that tells an agent when to prefer this tool over guessing a sibling tool name.

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.

Resources