Skip to main content
Glama
Sign In
Workfile

Workfile

by illodev
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Patch managed documentation

project_doc_patch
Idempotent

Patch managed documents with optimistic concurrency. Validate expected revision to prevent overwriting concurrent edits.

Instructions

Patch a managed document using optimistic concurrency. Indexed repository docs are intentionally read-only through this tool — edit those files directly.

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": {
      "id": "<id>",
      "changes": "<changes>"
    },
    "name": "project_doc_patch"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesManaged document to patch, e.g. DOC-0003.
changesYesFrontmatter fields to overwrite, plus body to replace the Markdown. Only the keys present are touched. Use project_doc_move to change the folder.
expectedRevisionNoRevision string from an earlier read of this record. The write is refused if it no longer matches, so a concurrent edit is reported rather than overwritten. Omit to skip the check.

Output Schema

NameRequiredDescriptionDefault
recordYesA canonical record with its body, revision and reference graph.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.5.4
    • addedInput schema / properties / changes / description
      Added value: +"Frontmatter fields to overwrite, plus body to replace the Markdown. Only the keys present are touched. Use project_doc_move to change the folder."
    • addedInput schema / properties / expectedRevision / description
      Added value: +"Revision string from an earlier read of this record. The write is refused if it no longer matches, so a concurrent edit is reported rather than overwritten. Omit to skip the check."
    • addedInput schema / properties / id / description
      Added value: +"Managed document to patch, e.g. DOC-0003."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "additionalProperties": true,
+  "properties": {
+    "record": {
+      "additionalProperties": true,
+      "description": "A canonical record with its body, revision and reference graph.",
+      "properties": {
+        "archived": {
+          "description": "Whether the record lives in the archive directory.",
+          "type": "boolean"
+        },
+        "body": {
+          "description": "Markdown body below the frontmatter.",
+          "type": "string"
+        },
+        "created": {
+          "description": "Creation date, YYYY-MM-DD.",
+          "type": "string"
+        },
+        "file": {
+          "description": "File name within the collection directory.",
+          "type": "string"
+        },
+        "id": {
+          "description": "Stable record ID.",
+          "type": "string"
+        },
+        "incoming": {
+          "description": "Backlinks: references other records make to this one.",
+          "items": {
+            "additionalProperties": true,
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "incomingTotal": {
+          "description": "Total backlinks, which may exceed the returned page.",
+          "type": "integer"
+        },
+        "issues": {
+          "description": "Validation findings doctor would report for this record.",
+          "items": {
+            "additionalProperties": true,
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "kind": {
+          "description": "Record family: card, doc, change, release or memory.",
+          "type": "string"
+        },
+        "outgoing": {
+          "description": "References this record makes to others.",
+          "items": {
+            "additionalProperties": true,
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "path": {
+          "description": "Repository-relative path to the Markdown file.",
+          "type": "string"
+        },
+        "recordType": {
+          "description": "Type within the family.",
+          "type": "string"
+        },
+        "revision": {
+          "description": "Content hash to pass back as expectedRevision on the next write.",
+          "type": "string"
+        },
+        "status": {
+          "description": "Lifecycle status.",
+          "type": "string"
+        },
+        "tags": {
+          "description": "Free-form tags.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "title": {
+          "description": "Human-readable title.",
+          "type": "string"
+        },
+        "updated": {
+          "description": "Date of the last write, YYYY-MM-DD.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "required": [
+    "record"
+  ],
+  "type": "object"
+}
  2. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

With idempotentHint=true annotation present, the bar is lower. The description adds genuine value by explaining the optimistic concurrency behavior (write refused on revision mismatch, concurrent edits reported rather than overwritten) and the read-only constraint on indexed repo docs. It doesn't mention the return format or error behavior in detail despite having an output schema, but the annotation plus inline concurrency explanation provide solid coverage.

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?

Two compact sentences that are front-loaded with the primary purpose and mechanism. The second sentence adds a critical safety constraint (read-only indexed docs) without padding. No filler or redundant restatement of the title. Slightly more guidance on return shape could push it higher, but overall it's economical and earns its sentences.

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?

The tool has nested objects and an output schema, so the description doesn't need to explain return values. The description covers the concurrency mechanism, the partial-update behavior, the read-only restriction, and references the move tool for folder changes. This is well-rounded for a patch tool of moderate complexity, though it could mention error responses (e.g., revision conflict handling details) beyond what the schema states.

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 meaningful context beyond schema: it notes indexed docs are read-only, and it states that only keys present in 'changes' are touched (partial update semantics). The expectedRevision parameter's concurrency behavior is already well-described in the schema itself, so the description's mention reinforces rather than duplicates it. The partial-touch semantics in the description meaningfully complement 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?

The description clearly states 'Patch a managed document using optimistic concurrency' — a specific verb+resource with a distinctive mechanism (optimistic concurrency). It also adds important scoping information by noting indexed repository docs are intentionally read-only through this tool. While the sibling project_doc_move is separately named for folder changes, the description doesn't explicitly differentiate from other patch tools like project_card_patch or project_memory_patch, though those target different resource types so the distinction is reasonably clear.

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 when to use (patch managed docs) and explicitly excludes indexed repository docs ('edit those files directly'), providing a clear when-not. The exclusion is valuable context. However, it doesn't contrast with the sibling patch tools (card, memory, changelog) explicitly, leaving the agent to infer resource-type differentiation, nor does it mention the project_doc_create/list alternatives for creation/listing flows.

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