Skip to main content
Glama
shanewiseman

paperclip-mcp

by shanewiseman

Create a document annotation thread

pc_post_issues_by_id_documents_by_key_annotations

Create an annotation thread on a document in an issue by specifying the quoted text, position, and base revision identifiers.

Instructions

Create a document annotation thread

Paperclip operation: POST /api/issues/{id}/documents/{key}/annotations. Authorization class: board_or_agent.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYes
pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYes
headersYes
encodingYes
status_codeYes
content_typeYes
Behavior2/5

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

Annotations already indicate a write operation (readOnlyHint false). The description adds no additional behavioral context, such as whether the thread is created immediately, what happens to existing threads, or if document lock is required.

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 description is very short with no fluff. The inclusion of the HTTP method and authorization class provides some value. However, the extreme brevity limits its usefulness.

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

Completeness1/5

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

For a tool with many nested required parameters and an output schema, the description is completely inadequate. It omits any explanation of the request body structure, response format, or required fields beyond the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, and the description provides no explanation of the complex nested parameters (body with selector, quote, position, etc.). The agent has no way to understand how to construct the request from the description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states 'Create a document annotation thread' which is a specific verb and resource. However, it fails to distinguish from the sibling tool 'pc_post_issues_by_id_documents_by_key_annotations_by_47c99d67c5' which likely also creates an annotation (possibly a reply). Without clarification, the agent may confuse the two.

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 like the GET or PATCH annotation tools. The only extra info is the authorization class, which is not usage advice.

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/shanewiseman/paperclip-mcp'

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