Skip to main content
Glama

Retry Knowledge Document

retry_knowledge_document

Process a document again after it failed or stalled.

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": "retry_knowledge_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
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.6/5.0
Behavior3/5

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

Annotations already disclose that this is a non-read-only, non-idempotent, non-destructive, closed-world operation, so the description's job is incremental. It adds only the failure/stall precondition and says nothing about whether prior partial content is discarded, whether the retry consumes credits, or how long reprocessing takes -- all material for a non-idempotent mutation. No contradiction with the annotations.

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?

A single twelve-word sentence with no filler, and the action is front-loaded. It is efficient to the point of terseness -- 'process ... again' is slightly softer than the tool's own 'retry' framing -- but nothing is wasted.

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?

The tool is low-complexity (3 params, fully documented schema, complete annotations, no output schema), so the definition is nearly callable as written. The remaining gap is what happens after the call -- whether it returns a job to poll via get_job_status or completes synchronously -- which is not inferable from either the description or a return schema.

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 100%: every parameter carries a description, including cross-references to list_knowledge_documents and list_knowledge_notebooks for obtaining ids, and app_id's fallback behavior. The description adds no parameter meaning beyond that, so the baseline 3 applies.

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 specific action and resource (process a document again) and adds a precondition that sharpens it: only after a failure or stall. That distinguishes it from add_knowledge_document (new ingest) and read_knowledge_document (read), though it never names the most relevant sibling, list_failed_knowledge_documents, as the source of candidates.

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?

There is explicit when-to-use guidance -- call this when a document has failed or stalled -- which an agent can act on directly. It stops short of exclusions or alternative routing (e.g. re-upload via add_knowledge_document if the source file itself was bad), so it lands at clear-context-but-no-exclusions.

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