Skip to main content
Glama

liz's doc public knowledge

related_documents

Read-onlyIdempotent

Find public documents related to a given canonical path by shared tags.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
limitNoNumber of related documents to return (default 5, maximum 20).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
documentsYes
generationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering the safety profile. The description adds a useful scope detail ('public documents') and the tag-based relationship, which lets the agent know that results are limited to public docs and shared tags. It does not disclose output formatting, but an output schema exists.

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?

A single sentence that front-loads the core operation and scope; every word earns its place. No unnecessary detail or repetition of annotations or schema.

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?

For a simple two-parameter tool with annotations and an output schema, the description plus schema is largely sufficient. It could benefit from explicit guidance around when to prefer it over search_documents, but that is a minor gap given the available structured information.

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 schema describes limit (default/max) but not path. The description partially fills this gap by clarifying that path is a 'canonical path' and that relation is via 'shared tags', adding meaning to the path parameter. It does not elaborate on limit, but that is already in the schema.

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?

States a specific verb ('Find'), a resource ('public documents'), and the linking mechanism ('shared tags'), which clearly differentiates from listing, reading, or searching. The notion of 'related' is specific, though it doesn't name sibling tools explicitly.

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?

No explicit guidance about when to choose this tool over search_documents or list_documents. The description implies a scenario (having a canonical path) but provides no exclusions or alternatives.

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