Skip to main content
Glama
backloghq

backlog

Read Task Doc

task_doc_read

:

Instructions

Read the markdown document attached to a task. Returns the document content as text, or an error if no document is attached. Use task_list with filter '+doc' to find tasks that have documents attached.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesTask ID number (e.g. '1') or UUID.
Behavior3/5

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

No annotations provided, so description carries full burden. Adds valuable behavioral context: specifies return format ('content as text') and failure mode ('error if no document attached'). However, lacks disclosure on rate limits, document size constraints, or specific error types.

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?

Three sentences with zero waste: action definition, return/error disclosure, and usage guidance. Well-structured and front-loaded. Every sentence earns its place without redundancy.

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?

Appropriate for a simple single-parameter read operation. Covers purpose, return type, error condition, and discovery mechanism. Lacks output schema but description compensates with return value disclosure. Could enhance by explicitly contrasting with task_doc_write/delete.

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 has 100% coverage with 'Task ID number (e.g. '1') or UUID.' Description adds contextual meaning that this ID refers to a task with an attached document ('document attached to a task'), but does not elaborate on ID format beyond schema.

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?

Clear specific verb ('Read') + resource ('markdown document attached to a task'). Distinguishes from sibling task_list by explicitly referencing it with the '+doc' filter to locate eligible tasks, and implies distinction from task_doc_write/delete through the specific read action.

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?

Provides explicit prerequisite workflow: 'Use task_list with filter '+doc' to find tasks that have documents attached.' Also states error condition ('error if no document is attached'), implying when not to use. Lacks explicit naming of task_doc_write/delete as alternatives for modification.

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/backloghq/backlog'

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