Skip to main content
Glama

Rename Knowledge Document

rename_knowledge_document

Set the name a document is shown under (its file name stays); an empty name clears it.

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": {
      "notebook_id": "<notebook_id>",
      "document_id": "<document_id>",
      "name": "<name>"
    },
    "name": "rename_knowledge_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
app_idNoOptional app whose notebooks to use. Omitted: the owner's own Business Brain.
document_idYesThe document id, from list_knowledge_documents.
notebook_idYesThe notebook id, from list_knowledge_notebooks.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.7/5.0
Behavior4/5

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

With annotations already declaring readOnlyHint=false and destructiveHint=false, the description still adds real value by disclosing two behaviors the annotations do not: the file name is untouched, and an empty name clears the display name entirely. There is a mild tension with idempotentHint=false, since setting a fixed display name would normally be idempotent, suggesting hidden side effects (search indexing, audit entries) that the description never explains; no permission or error behavior is described.

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?

One compact sentence that front-loads the core action and uses the parenthetical for the crucial non-obvious qualifier (file name unchanged), with the clearing edge case appended last. Nothing is redundant, though the semicolon clause could stand as its own short sentence for easier scanning.

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 four-parameter, low-complexity mutation tool with no output schema and non-destructive annotations, the description supplies the essentials: what changes, what does not, and the clearing case. It is slightly thin on prerequisites (permissions, whether the document must be ready/processed) and gives no hint about the response, but nothing critical to correct invocation is missing.

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 75%, so notebook_id, document_id and app_id are already documented in the schema and the description need not repeat them. The description does cover the one undocumented parameter, name, by establishing that it is a display label and that an empty string is the clearing sentinel; it says nothing about the 200-character limit or how the name is normalized/validated.

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?

The description names a precise operation ('Set the name a document is shown under') rather than restating the title, and it distinguishes the display name from the underlying file name, which is the key ambiguity for a rename tool in a family that also contains rename_knowledge_notebook and rename_app_file. It stops short of naming those siblings explicitly, so it does not fully disambiguate by name.

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

Usage Guidelines3/5

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

Usage is only implied: an agent can infer you call this to change a document's displayed label rather than its file, and the parenthetical about the file name staying put implicitly steers it away from file-rename siblings. There is no explicit when-to-use/when-not statement, no mention of rename_knowledge_notebook or update_knowledge_note as alternatives, and no prerequisites such as needing the document to exist or belong to the given notebook.

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