Skip to main content
Glama

Add a knowledge document

dosai_add_knowledge_text

Add a text document to the knowledge base (a price list, services, answers). The bot starts using it within a minute. To replace an outdated document, add the new one and switch the old one off with dosai_update_knowledge_document. 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>",
      "name": "<name>",
      "content": "<content>"
    },
    "name": "dosai_add_knowledge_text"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesShort clear name, e.g. "Price list".
contentYesThe full text.
project_idYesFrom dosai_list_projects.

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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."
  2. Changed1 schema field changed
    • 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)$"
  3. Added

TDQS

A4.2/5.0
Behavior4/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false, openWorldHint=false), it discloses two genuinely useful traits: eventual propagation ('The bot starts using it within a minute') and the editor-role authorization requirement. The remaining gap is the response — no output schema exists and the description never says whether the new document's id is returned, which matters for the follow-up update call it recommends.

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 core action and immediately followed by the replacement workflow and the permission prerequisite. No filler and no repetition of schema or annotation content.

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 simple 3-parameter create tool with full schema coverage and no output schema, the definition covers purpose, timing behavior, role requirement and the replacement path. The only shortfall is the unstated return value, which an agent needs to chain into dosai_update_knowledge_document.

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%, with name, content and project_id each documented in-schema (including the pointer to dosai_list_projects), so the schema carries the parameter burden. The description's parenthetical examples hint at what belongs in content but add no format, size, or ID semantics beyond the schema, so the baseline 3 applies.

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 verb and resource ('Add a text document to the knowledge base') and clarifies the resource with concrete examples ('a price list, services, answers'), which disambiguates it from the many other add_* siblings. It also names the sibling used for the adjacent replacement workflow, so an agent can tell add apart from update at a glance.

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 gives clear conditional guidance: to replace an outdated document, add the new one and switch the old one off via dosai_update_knowledge_document, plus the 'Requires editor role' prerequisite. What it does not cover is the boundary with dosai_edit_knowledge_document — whether tweaking existing content should go through edit instead of an add-then-deactivate cycle.

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