Skip to main content
Glama

Switch or rename a knowledge document

dosai_update_knowledge_document

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.

Input Schema

NameRequiredDescriptionDefault
nameNo
is_activeNofalse = the bot stops using it.
project_idYesProject id, as returned by dosai_list_projects.
document_idYesKnowledge base document id, as returned by dosai_list_knowledge.
always_includeNotrue = attached to every answer (for short key facts only).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare non-readOnly, non-destructive, non-idempotent, openWorld, so the safety profile is largely covered. The description adds genuinely useful context beyond the annotations: the authorization requirement (editor role) and the scope limitation that document text is off-limits. No contradiction with annotations.

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?

Two tight sentences that lead with the core operations; every clause earns its place (behavior, scope exclusion, prerequisite) with no filler or repetition.

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 mutation tool with only two required ids and no output schema, the description covers what changes, what it does not change, and the permission gate. Given the annotations already handle the safety profile, nothing an agent needs to call it correctly is missing.

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 80%, so the schema carries most parameter meaning. The description maps the meaningfully-named operations to parameters: switch on/off implies is_active, rename implies name, and always-attach implies always_include, adding semantic signal on top of 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?

States specific operations (switch on/off, rename, always-attach) on a named resource (knowledge document), so the agent knows exactly what it does. It implicitly separates itself from text editing, but does not explicitly distinguish itself from the close sibling dosai_edit_knowledge_document, which limits it to a 4.

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?

Provides clear context and an explicit when-not ('the text itself cannot be edited here: add a new document instead') plus a prerequisite ('requires editor role'). It stops short of naming the specific alternative tool or covering all sibling conflicts, so it is not a 5.

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