Skip to main content
Glama

Associate Document

associate_document
Idempotent

File a document you already published into a Project you own, addressed by slug. Requires the projects:write scope in addition to documents. Identify the Project with exactly one of project_id (uuid) or project_key — passing both, or neither, is an error. Repeating the same call is a no-op.

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": {
      "slug": "<slug>"
    },
    "name": "associate_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesSlug of a document you own
project_idNoProject id — exactly one of project_id or project_key is required
project_keyNoAdopted Project key — exactly one of project_id or project_key is required

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare idempotentHint=true and destructiveHint=false, but the description adds real context: the required OAuth scopes beyond the obvious one and the explicit error condition for passing both or neither project identifier. The no-op statement restates idempotentHint but usefully explains what the agent will observe on repeat.

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 short sentences, front-loaded with the action and resource, then auth requirements, then the identifier constraint and idempotency. No redundant or filler wording.

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?

For a non-destructive, idempotent mutation with a fully described schema and no output schema, the description covers the essentials: scope requirements, the exactly-one-of rule, and repeat-call behavior. It could optionally note what the call returns (e.g. the project association), but nothing needed to invoke it correctly is missing.

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 coverage is 100% and the schema already documents slug, project_id (uuid format), and the exactly-one-of rule, so the description mostly mirrors structured data. It adds only the ownership qualifier ("a document you own") and no format or syntax detail beyond the 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?

The description opens with a specific verb and resource ("File a document you already published into a Project you own") plus the addressing mechanism (slug), which distinguishes it from publish_document and disassociate_document without opening either 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 states the preconditions clearly: the document must already be published and owned, and the caller needs the `projects:write` scope in addition to `documents`. It does not explicitly route to the inverse operation (disassociate_document) or say when not to use it, so it stops short of full alternative guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.