briefd

Overview Schema Source Related Servers Discussions Admin

propose_update

Propose corrections or additions to knowledge documents as a git branch and pull request for human review. Ensures served content remains unchanged until merged.

Instructions

Propose a change to a knowledge document — fix an outdated rule, add a missing decision, create a document — for humans to review. Commits the complete new file to a git branch briefd/proposal- (and opens a pull request when a forge is configured); returns branch, commit and PR URL. Never changes what briefd serves until a human merges. Use it for knowledge that is wrong, stale ('code changed since' in bundles) or missing, not for scratch notes. Fails without a writable git source.

Input Schema

TableJSON Schema

Name	Required	Description
`doc_path`	Yes	Repository-relative path of the document to change or create, inside a scope folder, e.g. domain/rules/refunds.md or projects/ledger-service/notes.md. Must end in .md.
`new_content`	Yes	The complete new content of the file as Markdown, including front matter if the document has any — not a diff or a fragment. Fetch the current content with get_document first when editing.
`change_description`	Yes	Why this change is needed and what evidence you have, written for the human reviewer (becomes the commit message and pull request description).

Output Schema

TableJSON Schema

Name	Required	Description	Default
`branch`	Yes
`commit`	Yes
`pr_url`	No
`pushed`	Yes
`proposal_id`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv0.5.0Sep 22, 2026

changedInput schema / properties / change_description / description

Previous value: -"Why this change is needed, for the reviewer (becomes the commit/PR description)"New value: +"Why this change is needed and what evidence you have, written for the human reviewer (becomes the commit message and pull request description)."

changedInput schema / properties / doc_path / description

Previous value: -"Repository-relative path of the document to change or create, e.g. domain/rules/refunds.md"New value: +"Repository-relative path of the document to change or create, inside a scope folder, e.g. domain/rules/refunds.md or projects/ledger-service/notes.md. Must end in .md."

changedInput schema / properties / new_content / description

Previous value: -"The complete new content of the file (Markdown, including front matter if any)"New value: +"The complete new content of the file as Markdown, including front matter if the document has any — not a diff or a fragment. Fetch the current content with get_document first when editing."

First observedv0.4.0Sep 21, 2026

TDQS

A4.7/5.0

Behavior5/5

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

Beyond the annotations (readOnlyHint false, idempotentHint false), the description reveals key behavioral traits: commits to a branch named briefd/proposal-<id>, opens a PR when a forge is configured, returns branch/commit/PR URLs, never changes served content until human merge, and fails without a writable git source. This is rich, accurate context that annotations alone do not provide.

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?

The description is compact yet information-dense, with no filler. Purpose, mechanics, side effects, usage guidance, and failure mode are each covered in two substantive sentences, and the most important constraint (human review, no live change) is front-loaded.

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

Completeness5/5

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

For a write/proposal tool with no read-only or idempotency annotation, the description covers everything an agent needs: behavior, side effects, return values, prerequisites, failure mode, and when not to use it. The presence of an output schema further covers return-value details without requiring elaboration in the description.

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 description coverage is 100%, so the schema fully documents all three parameters. The description adds some contextual reinforcement, such as 'complete new file' and 'fetch current content with get_document first,' but does not materially expand on what the schema already states, keeping this at the baseline for high coverage.

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: proposing a change to a knowledge document for human review, with concrete examples (fix outdated rule, add missing decision, create a document). It clearly distinguishes itself from the read-only get_document and other siblings by emphasizing the proposal/branch/PR workflow.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states when to use the tool: for knowledge that is wrong, stale, or missing, and not for scratch notes. It also conditions behavior on environment state (forge configured, writable git source required), which gives an agent clear go/no-go signals.

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

Deploy Server