Skip to main content
Glama

get_markdown

Retrieve a specific segment of markdown content from an OCR task using the task ID, offset, and length parameters.

Instructions

Return a slice of a task's markdown result.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
offsetNo
task_idYes
max_lengthNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior2/5

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

No annotations are provided, so the description carries full burden. It only states the operation (return a slice) without disclosing side effects, error behavior, or authentication requirements. This is minimal behavioral disclosure.

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?

The single sentence is concise and front-loaded with the core action. However, it could include brief parameter hints without becoming verbose; it is efficient but not maximally informative within the same length.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite having an output schema, the description does not clarify what the output contains (e.g., content string, metadata). The parameters are unexplained, and there is no discussion of edge cases or required context (e.g., task must be processed). This is incomplete for a tool with 3 parameters and no annotations.

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%, meaning the property descriptions in the schema are empty. The tool description does not explain the meaning of offset or max_length, which are critical for correct usage. Default values are given but not their semantics.

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?

The description clearly states it returns a slice of a task's markdown result, using specific verb and resource. However, it does not differentiate from sibling tools like get_full_result or get_content_blocks, missing the highest clarity level.

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 guidance on when to use this tool versus alternatives (e.g., get_full_result for the entire markdown). No mention of prerequisites or limitations, leaving the agent without usage context.

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/asharca/ocrplane-cli'

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