Skip to main content
Glama

get_document

Retrieves a document overview from a knowledge base, including metadata, abstract, section outline, and character count.

Instructions

Overview of a document: metadata, abstract, section outline and total character count.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kbYes
doc_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

No annotations are provided, so the description carries the full burden of disclosing behavior. It does disclose the output composition, which is useful, and 'get' implies a read operation. However, it does not state whether the operation is read-only, what happens on missing documents, or whether it excludes full text beyond the term 'Overview'.

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?

The description is a single, front-loaded sentence where every phrase adds meaning. It starts with the core purpose and then lists concrete contents without any filler or repetition.

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?

The presence of an output schema covers return-value documentation, and the tool is relatively simple. Still, with no usage guidance and no parameter semantics in the description, an agent selecting between get_document and get_document_text has incomplete context to make a confident choice.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, and the description does not explain what kb or doc_id mean beyond their generic names and titles. An agent must infer that kb identifies a knowledge base and doc_id identifies the target document, which is not explicitly communicated.

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, 'Overview of a document', and enumerates exactly what is returned: metadata, abstract, section outline, and total character count. This clearly distinguishes it from sibling get_document_text, which presumably returns full text.

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?

The description provides no explicit when-to-use or when-not-to-use guidance and does not mention alternatives such as get_document_text or search_documents. The intended use case is only implied by the word 'Overview', leaving the agent to infer which sibling tool is appropriate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/notwhiteblank/scholar-rag-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server