Skip to main content
Glama

ringkit_get_knowledge_document

Read-onlyIdempotent

Read one uploaded document (documentId) with its extracted sections.

Input Schema

NameRequiredDescriptionDefault
businessIdNoDefaults to the business of the API key in the Authorization header.
documentIdYesThe document's id (from list_knowledge_documents).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds value by noting the response includes extracted sections, but says nothing about auth scope, error behavior for missing documents, or size/pagination of extracted content.

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 front-loaded sentence with no filler. It is efficient, though slightly terse even for a simple read tool.

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 read-only tool with full schema coverage and annotations, this is close to sufficient. The main residual gap is what "extracted sections" looks like and whether the call fails for unprocessed documents.

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 description coverage is 100%, with both businessId and documentId documented in the schema, so the schema carries the parameter burden. The description only echoes documentId, adding no semantics beyond structured data; baseline 3 applies.

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 and resource ("Read one uploaded document") and notes the return includes extracted sections. It is distinguishable from list_knowledge_documents by the singular scope, though it never names siblings explicitly.

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

Usage Guidelines3/5

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

Usage is only implied: fetch a single document when you have a documentId. There is no explicit when-to-use/when-not guidance or pointer to alternatives such as list_knowledge_documents or get_knowledge for retrieving knowledge content.

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