Skip to main content
Glama

get_document

Read a single Frappe document by doctype and name, choosing specific fields and limiting returned child-table rows to keep responses focused.

Instructions

Read one document, selecting fields and bounding any returned child-table rows.

Input Schema

NameRequiredDescriptionDefault
nameYes
fieldsNo
doctypeYes
child_row_limitNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.5/5.0
Behavior2/5

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

With no annotations, the description must carry the full behavioral burden. 'Read' implies non-mutation and 'bounding' implies child-row limiting, but it does not disclose permissions, not-found/error behavior, whether child rows are silently truncated, or how the limit interacts with the returned output.

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 definition is a single front-loaded sentence with no wasted wording. It states the action and two important behaviors immediately.

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?

An output schema exists, so return-value details need not be repeated. Still, the definition is thin for a 4-parameter read tool with no annotations and no schema descriptions, leaving gaps around required parameters, permissions, error behavior, and sibling selection.

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 0%, so the description must compensate. It adds meaning for fields ('selecting fields') and child_row_limit ('bounding any returned child-table rows'), but leaves doctype and name unexplained and does not clarify formats or the default child-row limit.

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 verb and resource: 'Read one document.' The phrase 'one document' distinguishes it from sibling listing tools such as list_documents, and it also names the field-selection and child-row-bounding behavior.

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 implied: this is the tool for fetching a single document by doctype and name. However, it does not explicitly say when to use it instead of list_documents, get_doctype_schema, or other siblings, and it gives no exclusions or prerequisites.

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