Skip to main content
Glama

about

Read-onlyIdempotent

Platform documentation and info: how it works (Answer, Analytics, Custom Analytics), usage.

Input Schema

NameRequiredDescriptionDefault
topicYesTopic: platform, manual, connectors, or a docs section

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds only a loose indication of content areas (Answer, Analytics, Custom Analytics) and says nothing about the form, depth, or freshness of the documentation returned beyond what annotations supply.

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?

A single short, front-loaded sentence with no padding. The trailing fragment 'usage.' is a bit clipped and the enumerated parenthetical makes it feel like notes rather than a polished definition, keeping it short of a 5.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter read-only tool the description is minimally adequate, but with no output schema the agent gets no picture of what a documentation response looks like (full page, snippet, links), and the topic vocabulary is only partially covered. It should say more about the return shape.

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?

With one parameter at 100% schema description coverage, the schema already documents 'topic' with example values (platform, manual, connectors, docs section). The description's parenthetical list adds marginal color but no syntax, format, or fallback behavior beyond the schema, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description identifies the resource (platform documentation and info) but uses a noun phrase rather than a specific retrieval verb, and it never distinguishes itself from doc-adjacent siblings such as ask_library, tools_schema, or discover_tools. An agent can guess it returns documentation but not precisely what it returns that those tools don't.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no statement of when to call this versus the many other knowledge/discovery siblings (ask_library, discover_tools, tools_schema, path_resolver). The mention of sub-areas ('how it works', 'usage') hints at scope but gives no selection criteria or exclusions.

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.