Save SharedBrief edits
save_document_from_appSave document content with revision matching. Published documents update at their existing link.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| content | Yes | ||
| expectedRevision | Yes |
save_document_from_appSave document content with revision matching. Published documents update at their existing link.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| content | Yes | ||
| expectedRevision | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and idempotentHint=false, so the safety profile is covered. The description usefully adds that writes are revision-matched and that already-published documents are updated in place rather than forked to a new link. It does not say what happens on a revision mismatch or whether existing content is fully replaced, which matters for a destructive write.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, with the core action front-loaded and the published-link consequence second. No filler, though the second sentence could have carried more useful detail in the same space.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
A destructive, non-idempotent write with three required parameters, no parameter documentation, and no output schema needs more than two sentences. Failure semantics for a stale revision, content replacement behavior, and required authorization are all absent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% across three required parameters. 'Revision matching' hints at the meaning of expectedRevision but never states that it must equal the current server revision or what a mismatch does. The 'id' target and the two distinct content shapes (block array vs static HTML) are left entirely to the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Save document content') and adds the revision-matching qualifier, so the agent knows this is a content-write, not a metadata update. It does not distinguish itself from the sibling update_document or explain the title's SharedBrief framing, so it stops short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No statement of when to use this tool versus the obvious alternatives (update_document, publish_document, create_document). The note that published documents update at their existing link is a behavior, not a when-to-use rule or precondition.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.