Skip to main content
Glama

Update Basecamp Document

basecamp_update_document

Update a Basecamp document's title or HTML content, or apply partial append, prepend, and search-replace edits to save tokens.

Instructions

Update a document. Use partial content operations when possible to save on token usage.

HTML rules for content:

  • Allowed tags: p, span, h2, h3, h4, br, strong, em, strike, code, a (with href attribute), pre, ol, ul, li, blockquote, mark, figure, figcaption, table, tbody, tr, th, td, div, bc-attachment.

  • Wrap every paragraph in ..., and put between one paragraph and the next. Both parts are necessary: newlines and blank lines in your HTML are discarded, and Basecamp shows no space around a on its own, so two paragraphs with nothing between them are shown as one block of text. Do not rely on line breaks in your HTML to separate paragraphs.

  • Headings: use , , as appropriate.

  • Inline code: text. Preformatted blocks: text.

  • Ordered lists: .... Unordered: ....

  • Tables: Heading...Cell...

  • To mention a person: . Put the tag where the name must show in the text, for example "Thanks for the fix". The person gets a notification. If the ID is not a person, the tool returns an error and writes nothing. Get person IDs from basecamp_list_people, or from the people in other responses (assignees, creators).

  • Single image:

  • Image gallery: wrap multiple in a .

  • A bc-attachment needs an attachable_sgid. For a file that is already in Basecamp, take the sgid from the HTML content of the message, comment or card that shows it, or use basecamp_list_recordings. For a file that is not in Basecamp yet, such as an image at an external URL or a screenshot on disk, upload it with basecamp_create_attachment and use the sgid that it returns. There is no tag, so an external image URL can never be embedded directly: upload it, or accept that it stays a plain link.

  • Basecamp auto-enriches bc-attachment tags after saving (adds url, href, filename, content-type, etc.) — you never need to write those.

  • When you see an existing, already-enriched tag (e.g. from a previous list/get call), leave its inner HTML alone. Before any content_append/content_prepend/search_replace runs, it is automatically collapsed back to its minimal form (sgid, presentation, caption, and content-type for mentions) — you don't need to strip it yourself, and doing so manually is unnecessary and risks mismatched find strings.

  • Background highlights: ...

  • Text color highlights: ...

  • For both, N is 1 (yellow), 2 (amber), 3 (red), 4 (pink), 5 (purple), 6 (blue), 7 (teal), 8 (near-white), or 9 (light gray).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleNoNew document title
contentNoIf provided, replaces entire HTML content. Cannot be used with content_append, content_prepend, or search_replace.
document_idYesDocument ID to update
content_appendNoText to append to the end of current content. Cannot be used with content.
search_replaceNoArray of search-replace operations to apply to current content. Cannot be used with content.
content_prependNoText to prepend to the beginning of current content. Cannot be used with content.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.2.1
    • removedInput schema / properties / bucket_id
      Removed value: -{
      -  "description": "Project/bucket ID",
      -  "type": "number"
      -}
    • changedInput schema / required
      Previous value: -[
      -  "bucket_id",
      -  "document_id"
      -]New value: +[
      +  "document_id"
      +]
  2. Addedv1.0.3

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare the safety profile (readOnly=false, destructive=false, idempotent=false, openWorld=true). The description goes beyond that by disclosing non-obvious behavior: bc-attachment tags are auto-enriched on save, existing enriched tags are auto-collapsed before append/prepend/search_replace, and an invalid person ID causes an error with no write. Auth/permission requirements and the reversibility of full content replacement are not addressed.

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?

Purpose and the token-saving hint are front-loaded, then the formatting rules follow. The block is long, but for a tool whose core job is emitting valid HTML the rules are substantive rather than filler; a few explanatory asides could still be tightened.

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?

With no output schema, the description could say more about the response, and it omits permission requirements. However, for a complex HTML-content mutation it covers the critical ground: format rules, attachment handling, error behavior, and the mutual exclusivity implied by the modes.

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

Parameters4/5

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

Schema description coverage is 100%, so the baseline is 3. The description adds substantial meaning beyond the schema by defining the exact HTML dialect required for the content parameters (allowed tags, paragraph rules, bc-attachment usage, highlight variables), which the schema does not provide and which is essential to invoking the content fields correctly.

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 clear verb+resource ("Update a document") and the name reinforces it. It does not, however, distinguish itself from siblings like basecamp_update_message or basecamp_create_document, so the agent gets no explicit routing signal beyond the name itself.

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?

"Use partial content operations when possible to save on token usage" gives guidance on choosing among the content/content_append/content_prepend/search_replace modes, which is useful. But there is no when-to-use/when-not guidance relative to sibling tools, and no prerequisites or exclusions for the tool as a whole.

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