Skip to main content
Glama

update_knowledge_doc

Update an existing knowledge/documentation entry by id. Pass only the fields to change (type, title, content, tags, and/or adrStatus/supersededBy/repoUrl). Mirrors delete_knowledge_doc: the id comes from list_knowledge_docs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
tagsNo
typeNo
titleNo
contentNo
repoUrlNoOnly meaningful for type "adr" — see create_knowledge_doc's own description. Which specific repo this decision is about ("owner/repo" or a full github.com URL); omit/clear to mark it as applying to every repo in the project.
adrStatusNoOnly meaningful for type "adr". Move to "accepted" once a proposed decision is actually decided, or to "superseded" when a newer ADR replaces this one (also set supersededBy).
supersededByNoOnly meaningful when setting adrStatus to "superseded" — the id (from list_knowledge_docs) of the ADR that replaces this one.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / repoUrl
      Added value: +{
      +  "description": "Only meaningful for type \"adr\" — see create_knowledge_doc's own description. Which specific repo this decision is about (\"owner/repo\" or a full github.com URL); omit/clear to mark it as applying to every repo in the project.",
      +  "type": "string"
      +}
  2. Changed3 schema fields changed
    • addedInput schema / properties / adrStatus
      Added value: +{
      +  "description": "Only meaningful for type \"adr\". Move to \"accepted\" once a proposed decision is actually decided, or to \"superseded\" when a newer ADR replaces this one (also set supersededBy).",
      +  "enum": [
      +    "proposed",
      +    "accepted",
      +    "superseded"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / supersededBy
      Added value: +{
      +  "description": "Only meaningful when setting adrStatus to \"superseded\" — the id (from list_knowledge_docs) of the ADR that replaces this one.",
      +  "type": "string"
      +}
    • changedInput schema / properties / type / enum
      Previous value: -[
      -  "metric",
      -  "workflow",
      -  "convention",
      -  "guide"
      -]New value: +[
      +  "metric",
      +  "workflow",
      +  "convention",
      +  "guide",
      +  "adr"
      +]
  3. Added

TDQS

A4/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=false and destructiveHint=false. The description adds genuinely useful behavioral context beyond that: partial-update semantics ('pass only the fields to change') and where the required id originates. It stops short of describing permissions, validation failures, or what a type change does to dependent fields like repoUrl.

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?

Three tight sentences with the core action front-loaded and the id-provenance note last. No filler, though 'Mirrors delete_knowledge_doc' is only marginally useful since the relationship isn't explained.

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

Completeness3/5

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

For an 8-parameter mutation tool with 38% schema coverage and no output schema, the description is adequate but thin. It does not explain the type enum, tags replacement semantics, or the interaction between type changes and the ADR-specific fields.

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 low at 38%, so the description carries more of the burden. It enumerates all eight field names, which helps as an inventory, but adds no meaning for tags/title/content/type and does not restate the ADR-only conditionality that the schema itself documents. Baseline-to-slightly-above is appropriate.

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?

States a specific verb and resource ('Update an existing knowledge/documentation entry by id') and distinguishes itself from the create/delete/list siblings by name. An agent can identify the operation without opening the 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?

Gives clear context: pass only the fields to change, and the id comes from list_knowledge_docs. It routes the agent to the right source for the required id, though it never explicitly states when to prefer this over delete_knowledge_doc or create_knowledge_doc.

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.

Resources