Skip to main content
Glama

attach_working_doc

Link a working doc to a Linear or GitHub ticket using its Tares id or identifier, keeping the doc stored in Tares.

Instructions

Link a working doc (write it first with write_doc, kind working) to a ticket, by the ticket's Tares id, Linear identifier or GitHub identifier (GH-12). Works for tickets in Linear or GitHub too: the working doc stays in Tares.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "ticket": "<ticket>",
      "doc": "<doc>"
    },
    "name": "attach_working_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
docYes
ticketYes
projectNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.57.0

TDQS

A3.9/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It usefully discloses cross-system behavior — tickets may live in Linear or GitHub while 'the working doc stays in Tares' — which is real behavioral context. It says nothing about permissions, idempotency (does re-attaching duplicate?), or failure modes for invalid identifiers.

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?

Two sentences, front-loaded with the action and followed by the prerequisite, then the cross-system caveat. Dense but every clause earns its place; the parenthetical nesting costs a little readability.

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?

An output schema exists, so return values need no explanation, and the essential calling context (prerequisite tool, accepted ticket id formats, cross-system scope) is present. The unexplained `project` parameter is the main remaining gap for a 3-parameter tool with zero schema coverage.

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, and it does for `ticket` by enumerating accepted identifier forms (Tares id, Linear identifier, GitHub identifier such as GH-12). It only implicitly characterizes `doc` as a working doc created by write_doc, and never mentions the `project` parameter at all.

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 ('Link') and resource ('a working doc ... to a ticket') and names the sibling tool that must run first (write_doc, kind `working`). An agent can distinguish this from write_doc and get_doc without opening any schema.

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?

It gives a clear prerequisite and sequencing rule ('write it first with write_doc, kind `working`'), which is exactly the context needed to invoke it correctly. It does not state when *not* to use it or what happens if the doc was never written, but the positive guidance is strong.

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