Skip to main content
Glama

PulseWatch public knowledge

read_knowledge

Read-onlyIdempotent

Read an exact public document ID returned by search_knowledge. Only catalogue IDs are accepted; no URL fetching or file access.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
sourcesYes
revisionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior3/5

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

The annotations already cover readOnlyHint, idempotentHint, and destructiveHint, so the description's burden is reduced. It still adds meaningful behavioral context: only catalogue IDs are accepted and URL/file inputs are rejected. However, it does not disclose behavior on missing or invalid IDs, which would be a minor value-add beyond what annotations provide.

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 sentences, front-loaded with the action and the source of the ID, with no filler or redundant restatement. Every phrase earns its place.

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?

Given a single parameter, an output schema, and strong annotations, the description covers the core context: what to pass and what not to pass. It doesn't explicitly describe error behavior for missing documents, but that's supplemented by the output schema and the tool's false; for a read-only, idempotent tool this is adequate.

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?

With 0% schema coverage, the description carries the full burden for the 'id' parameter. It compensates by defining the id precisely: an exact public catalogue ID returned by search_knowledge, and it rejects URLs or file references. This gives the agent enough semantic grounding to populate the parameter correctly, despite lacking a detailed format specification.

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 states a specific operation (read) and resource (a public document by ID returned by search_knowledge), and differentiates it from arbitrary URL/file access. It also implies a contrast with list_offers by requiring an exact ID rather than listing, making the tool's role clear even without opening sibling schemas.

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

Usage Guidelines4/5

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

The description gives clear context: use this tool when you have an exact catalogue ID from search_knowledge, and explicitly says not to use it for URLs or file access. It does not name the sibling tools as alternatives, but the conditional guidance is sufficient for an agent to route between them.

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