Skip to main content
Glama

render_question_document

Renders question data into a four-part markdown document for human review and correction, enabling validation and refinement of the question pack.

Instructions

Render questions back into the four-part markdown a person can read and correct. Keep it next to the pack: the pack is for the machine, this is for the room.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
questionsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior2/5

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

With no annotations provided, the description must carry the full burden of behavioral disclosure. It only says 'Render' and describes the output format, but does not disclose side effects (e.g., whether it writes files, modifies data, or is read-only), nor does it describe the return value beyond relying on the output schema. This is a significant gap.

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 two sentences, with no filler. The first sentence states the core action, and the second adds useful context about its relationship to the pack. Every word earns its place, and it is appropriately front-loaded.

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?

For a single-parameter tool with an output schema, the description provides adequate purpose and usage context. However, it lacks transparency about side effects and parameter details, making it only minimally complete. There are clear gaps that could be filled with a short note on what the output looks like (e.g., 'Returns markdown text') and what format the questions should take.

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?

The schema has one parameter 'questions' with 0% description coverage. The description says 'Render questions' but does not explain the structure of the questions array or what fields each object should have. It adds no meaning beyond the parameter name, failing to compensate for the lack of schema documentation.

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 clearly states the tool renders questions into a four-part markdown document for human reading and correction. It uses a specific verb 'Render' with a clear resource ('questions') and output format, distinguishing it from siblings like write_pack and read_pack.

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 context for when to use this tool: it is meant to be kept next to the machine-readable pack, with the phrase 'the pack is for the machine, this is for the room' clarifying it produces a human-facing document. However, it does not explicitly name alternatives or state when not to use it.

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/R0DR0X/asistonto-mcp'

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