Skip to main content
Glama
backloghq

backlog

Write Task Doc

task_doc_write

:

Instructions

Attach or replace a markdown document on a task (spec, design, context, handoff notes). Each task can have one document. Writing replaces any existing doc. Automatically adds +doc tag and has_doc:true to the task for filtering. For short notes, use task_annotate instead. To read the doc back, use task_doc_read. To remove it, use task_doc_delete.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesTask ID number (e.g. '1') or UUID.
contentYesDocument content in markdown format. Replaces any existing document on this task.
Behavior4/5

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

No annotations provided, so description carries full behavioral burden. Discloses critical traits: destructive replacement ('Writing replaces any existing doc'), side effects ('Automatically adds +doc tag and has_doc:true'), and cardinality constraint ('Each task can have one document').

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?

Four sentences with zero waste: purpose, constraint, side effects, alternatives. Every sentence earns its place; well front-loaded with the core action in sentence one.

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?

No output schema exists, but description documents state changes (tagging) and cross-reences task_doc_read for retrieval. Sufficient for a 2-parameter write operation despite lack of annotations.

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 100%, establishing baseline 3. Description reinforces markdown format for content parameter and implies id refers to a task, but adds minimal semantic detail beyond what schema already provides.

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?

Specific verb+resource ('Attach or replace a markdown document on a task') with concrete examples (spec, design, context, handoff notes). Clearly distinguishes from sibling task_annotate by contrasting 'short notes' vs full documents.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit when-to-use alternatives named: 'For short notes, use task_annotate instead.' Also names siblings for complementary actions: task_doc_read and task_doc_delete for read/remove workflows.

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