Upload Knowledge Base Text

Changes state - verify before retry Adds a text document to a knowledge base and indexes it, so agents that use the knowledge base can draw on it from their next call. This is NOT a read-only action. Pass the document CONTENT as text — when a user shares a PDF or document in the conversation you already have its text, so send that directly; never base64-encode anything for this tool. Give it a short, unique title (the knowledge base rejects duplicate titles). Use list_knowledge_base_documents to find the kb_id. Suited to documents up to roughly a few hundred KB of text; for large PDFs or files that must keep their original layout, tell the user to upload from the dashboard.

Parameters

Name	Type	Required	Description
`kb_id`	`string`	Yes	The knowledge base ID, e.g. kb_abc123
`title`	`string`	Yes	Document title, unique within the knowledge base, e.g. “Refund policy”
`text`	`string`	Yes	The full document text, plain text or markdown
`description`	`string`	No	Optional one-line description of the document

Complete input schema

{
  "type": "object",
  "properties": {
    "kb_id": {
      "type": "string",
      "description": "The knowledge base ID, e.g. kb_abc123"
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 150,
      "description": "Document title, unique within the knowledge base, e.g. \"Refund policy\""
    },
    "text": {
      "type": "string",
      "minLength": 1,
      "description": "The full document text, plain text or markdown"
    },
    "description": {
      "type": "string",
      "maxLength": 500,
      "description": "Optional one-line description of the document"
    }
  },
  "required": [
    "kb_id",
    "title",
    "text"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Registered output schema

{
  "type": "object",
  "properties": {
    "document_id": {
      "description": "ID of the created document"
    },
    "knowledge_base_id": {
      "type": "string",
      "description": "The knowledge base it was added to, prefixed kb_"
    },
    "title": {
      "type": "string",
      "description": "The document title as stored"
    },
    "characters": {
      "type": "number",
      "description": "Length of the stored text in characters"
    },
    "status": {
      "type": "string",
      "description": "'processing' while the text is being indexed, 'ready' once searchable, 'failed' if indexing did not complete"
    },
    "note": {
      "type": "string",
      "description": "What happens next"
    }
  },
  "required": [
    "knowledge_base_id",
    "title",
    "characters",
    "status",
    "note"
  ],
  "additionalProperties": true,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Before you call

Connect and initialize the MCP client with OAuth or an API key for the intended workspace.
Provide the required parameters: kb_id, title, text.
If your OAuth grant covers several workspaces, also pass organization_id with the workspace to act in, from List My Organizations.

Example MCP request

Send tools/call after your client completes MCP initialization. Replace placeholder values with IDs and inputs from your workspace. For object and array parameters, follow the nested requirements in the parameter description instead of treating an empty value as complete.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "upload_knowledge_base_text",
    "arguments": {
      "kb_id": "kb_abc123",
      "title": "Example resource",
      "text": "VALUE"
    }
  }
}

Successful results include structuredContent and a text content block containing the same JSON. Check isError first, then read structuredContent or parse content[0].text. See MCP responses and errors for the full envelope and failure behavior.

Verify the result

Confirm the response is not marked isError and read the document’s status from the response. No MCP tool reads a document’s status afterwards: the knowledge base tools return knowledge bases, not their documents. Check processing in the dashboard or with the REST List Knowledge Base Documents endpoint.

Retry safety

This tool changes workspace state. After a timeout, read the affected resource before retrying so you do not create duplicate or conflicting changes.

List Knowledge Base Documents: list_knowledge_base_documents
Get Knowledge Base Document: get_knowledge_base_document
Get Knowledge Base Affected Agents: get_knowledge_base_affected_agents

Start Here

Tool Reference

Parameters

Complete input schema

Registered output schema

Before you call

Example MCP request

Verify the result

Retry safety

​Parameters

​Complete input schema

​Registered output schema

​Before you call

​Example MCP request

​Verify the result

​Retry safety

​Related MCP tools

​Related guides

Parameters

Complete input schema

Registered output schema

Before you call

Example MCP request

Verify the result

Retry safety

Related MCP tools

Related guides