Skip to content

AI Agents & MCP Server Guide (v0.12.5) ​

For AI Agents (Claude, Cursor, GitHub Copilot, Codex) & Builders: Purple8 DocIntel (v0.12.5) includes a built-in Model Context Protocol (MCP) Streamable HTTP server at /mcp. Any AI agent can connect directly to parse 70+ document formats across 75+ languages, extract typed entities, relationships, and structured tables, and optionally emit them straight into Purple8 Hyper Graph.

Machine-readable summary: /llms.txt


1. Connect Your AI Agent to /mcp ​

The /mcp endpoint accepts your DocIntel API key or Cloud Sandbox key via X-API-Key: <key> or Authorization: Bearer <key>.

bash
claude mcp add --transport http purple8-docintel "https://<your-docintel-host>/mcp" \
  --header "X-API-Key: <your-api-or-sandbox-key>"
json
{
  "mcpServers": {
    "purple8-docintel": {
      "url": "https://<your-docintel-host>/mcp",
      "headers": {
        "X-API-Key": "<your-api-or-sandbox-key>"
      }
    }
  }
}
json
{
  "servers": {
    "purple8-docintel": {
      "type": "http",
      "url": "https://<your-docintel-host>/mcp",
      "headers": {
        "X-API-Key": "<your-api-or-sandbox-key>"
      }
    }
  }
}
json
{
  "mcpServers": {
    "purple8-docintel": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://<your-docintel-host>/mcp",
        "--header",
        "X-API-Key:${DOCINTEL_KEY}"
      ],
      "env": {
        "DOCINTEL_KEY": "<your-api-or-sandbox-key>"
      }
    }
  }
}

2. MCP Tools Reference ​

ToolDescriptionArguments
docintel_ingest_textRun two-pass entity + relationship extraction on raw text.text (required), source_app (default "mcp-agent"), profile_hint ("aec" | "contract" | "financial" | "scientific" | "general"), auto_commit (bool), graph_base_url (optional), graph_api_key (optional)
docintel_ingest_urlDownload a document from an HTTP/HTTPS URL, parse it (PDF, DOCX, XLSX, IFC, DXF, STEP, etc.), and extract structured entities, relationships, and tables.url (required), source_app, profile_hint, auto_commit, wait_seconds (default 25), graph_base_url, graph_api_key
docintel_get_jobPoll or retrieve the extraction result for an asynchronous job.job_id (required), wait_seconds (optional long-poll)
docintel_list_formatsReturn all 70+ supported document formats grouped by category.None
docintel_healthReturn DocIntel service health and version (0.12.5).None

3. Standalone vs. Paired with Purple8 Hyper Graph ​

DocIntel works in two modes depending on whether you are using it standalone or paired with Purple8 Hyper Graph:

  1. Standalone Mode (auto_commit=false):
    • If you do not pass graph_base_url (or if you are using a Sandbox key without a target graph), docintel_ingest_text and docintel_ingest_url automatically default to auto_commit=false and return the complete structured JSON (entities, relationships, tables, metadata, calibrated confidence scores) directly to the agent.
  2. Paired with Purple8 Hyper Graph (auto_commit=true):
    • Pass graph_base_url and graph_api_key (or configure GRAPH__BASE_URL on the container) and set auto_commit=true. DocIntel parses the document and commits the extracted entities, relationships, and structured tables straight into your Hyper Graph tenant via POST /ingest/commit.

Dual-MCP Configuration (DocIntel + Hyper Graph Together) ​

json
{
  "mcpServers": {
    "purple8-docintel": {
      "url": "https://<your-docintel-host>/mcp",
      "headers": { "X-API-Key": "<your-docintel-key>" }
    },
    "purple8-graph": {
      "url": "https://<your-graph-host>/mcp?profile=starter",
      "headers": { "X-API-Key": "<your-graph-key>" }
    }
  }
}

Purple8 DocIntel v0.12.5 · Universal Document Intelligence · NVIDIA Inception Member · Red Hat Technology Partner.