Skip to main content
Glama

Switch or rename a knowledge document

dosai_update_knowledge_document
Destructive

Switch a knowledge document on or off, rename it, or make it always attached to every answer. The text itself cannot be edited here: add a new document instead. Requires editor role.

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": {
      "project_id": "<project_id>",
      "document_id": "<document_id>"
    },
    "name": "dosai_update_knowledge_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNo
is_activeNofalse = the bot stops using it.
project_idYesFrom dosai_list_projects.
document_idYesFrom dosai_list_knowledge.
always_includeNotrue = attached to every answer (for short key facts only).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / document_id / description
      Previous value: -"Knowledge base document id, as returned by dosai_list_knowledge."New value: +"From dosai_list_knowledge."
  2. Changed2 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedInput schema / properties / project_id / description
      Previous value: -"Project id, as returned by dosai_list_projects."New value: +"From dosai_list_projects."
  3. Changed2 schema fields changed
    • removedInput schema / properties / document_id / pattern
      Removed value: -"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    • removedInput schema / properties / project_id / pattern
      Removed value: -"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
  4. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so safety framing is partly covered; the description adds real value beyond that with the authorization requirement and the scoping limit that content edits are impossible here. It does not explain the consequences of the destructive flag, such as what happens to an existing document when it is switched off or to attachments when always_include is toggled.

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?

Three short sentences, front-loaded with the operations, followed by the exclusion and the prerequisite in descending order of importance. No redundant restatement of the title or annotations.

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?

For a five-parameter mutation with no output schema, the description covers scope, the excluded operation, and the permission requirement. The remaining gap is outcome behavior — whether toggling off or changing always_include affects existing answers or is reversible.

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 80%, with is_active, always_include, project_id, and document_id all self-documented, so the structured fields carry most of the meaning. The description maps 'rename it' onto name, the one undocumented parameter, but adds little beyond that baseline.

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 names a specific resource (knowledge document) and the exact operations supported: toggling active state, renaming, and always-include. It also separates itself from the editing sibling by stating 'The text itself cannot be edited here', so an agent can distinguish it from dosai_edit_knowledge_document without opening either schema.

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?

It gives an explicit when-not ('text cannot be edited here'), an alternative route ('add a new document instead'), and a prerequisite ('Requires editor role'). An agent knows both the correct use case and what to do when the request falls outside it.

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