Skip to main content
Glama
Sign In
Backlog MCP Server

Backlog MCP Server

by nulab
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_document

Read-only

Retrieves a Backlog document's plain-text content, returning up to a character limit per call and supporting pagination via start and nextStart offsets to read long documents in parts.

Instructions

Gets information about a document. The content is returned as plain text in plain, up to limit characters at a time; when nextStart is present, the rest can be read by calling again with start set to it.

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of characters of `plain` to return (default: 40000). Fewer may be returned so that the response fits the server's token limit; continue from `nextStart`.
startNoCharacter offset in `plain` to start reading from (default: 0). To read a long document in parts, pass the `nextStart` of the previous response.
documentIdYesDocument ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.23.2
    • addedInput schema / properties / limit
      Added value: +{
+  "description": "Maximum number of characters of `plain` to return (default: 40000). Fewer may be returned so that the response fits the server's token limit; continue from `nextStart`.",
+  "exclusiveMinimum": 0,
+  "maximum": 9007199254740991,
+  "type": "integer"
+}
    • addedInput schema / properties / start
      Added value: +{
+  "description": "Character offset in `plain` to start reading from (default: 0). To read a long document in parts, pass the `nextStart` of the previous response.",
+  "maximum": 9007199254740991,
+  "minimum": 0,
+  "type": "integer"
+}
  2. Addedv0.15.1
  3. Removedv0.13.1
  4. Changed1 schema field changedv0.11.0
    • addedInput schema / properties / organization
      Added value: +{
+  "description": "Optional organization name. Use list_organizations to inspect available organizations.",
+  "type": "string"
+}
  5. Addedv1.0.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=false, so safety is covered. The description adds behavior beyond that: content is truncated at `limit` and may be short of the requested size due to a server token limit, with continuation via `nextStart` — exactly the kind of operational detail annotations cannot carry.

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?

Two sentences, no filler, with the return shape and the paging contract front-loaded. Every clause carries information an agent needs.

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?

There is no output schema, and the description compensates by naming the returned fields (`plain`, `nextStart`) and explaining truncation. Only gap is that 'information about a document' beyond content is never enumerated.

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% and each parameter already documents defaults and the nextStart hand-off, so the schema is doing the heavy lifting. The description reinforces the limit/start/nextStart relationship but adds little syntax or semantics not already in the schema.

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?

States a specific verb+resource ('Gets information about a document') and immediately clarifies that the payload is plain-text content with paging. It is clear against list-oriented siblings like get_documents, but never explicitly distinguishes itself from get_document_tree or get_document_comments.

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

Usage Guidelines3/5

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

The pagination loop is spelled out (call again with `start` set to `nextStart`), which is real usage guidance. However there is no statement of when to prefer this over get_documents, get_document_tree, or get_document_comments, or any prerequisite/exclusion.

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

Deploy Server

Other Tools