AI Features

DocPlatform includes built-in AI capabilities powered by Claude (Anthropic) or OpenAI. These features help you write, improve, and explore your documentation faster.

Setup

Enable AI features by setting your provider and API key:

# .env
AI_PROVIDER=anthropic     # or "openai"
AI_API_KEY=sk-ant-...     # your API key
AI_MODEL=                 # optional — uses provider default if empty

Restart the server. AI features appear in the editor toolbar and are accessible via the API.

Supported providers

Override the model with AI_MODEL (e.g., claude-opus-4-6, gpt-4-turbo).

Check AI status

GET /api/v1/ai/status

Returns whether AI is enabled and which provider is configured.

Writing assist

Select text in the editor and use the AI toolbar to transform it:

API usage

POST /api/v1/ai/writing-assist

{
  "workspace_id": "01HJK...",
  "operation": "improve",
  "content": "This is the text to improve."
}

Operations: improve, simplify, expand, summarize, fix_grammar, translate

Response:

{
  "result": "Here is the improved text with better clarity and flow."
}

Doc chat

Ask questions about your workspace documentation and get context-aware answers.

In the editor

Click the Chat button in the sidebar to open the doc chat panel. Ask questions like:

• “How do I configure git sync?”
• “What authentication methods are supported?”
• “Summarize the deployment guide”

The AI searches your workspace content and provides answers grounded in your actual documentation.

API usage

POST /api/v1/ai/chat

{
  "workspace_id": "01HJK...",
  "messages": [
    { "role": "user", "content": "How do I configure git sync?" }
  ]
}

Supports multi-turn conversations — include previous messages in the messages array for context.

MCP server

DocPlatform includes a built-in Model Context Protocol (MCP) server with 24 tools, allowing AI agents like Claude Code, Claude Desktop, or Cursor to read, write, search, and manage your documentation directly.

Quick setup

docplatform mcp --workspace my-docs --api-key dp_live_abc123

Client configuration

Claude Desktop — add to claude_desktop_config.json:

{
  "mcpServers": {
    "docplatform": {
      "command": "docplatform",
      "args": ["mcp", "--workspace", "my-docs", "--api-key", "dp_live_abc123"]
    }
  }
}

Claude Code:

claude mcp add docplatform -- docplatform mcp --workspace my-docs --api-key dp_live_abc123

Cursor — add to .cursor/mcp.json:

{
  "mcpServers": {
    "docplatform": {
      "command": "docplatform",
      "args": ["mcp", "--workspace", "my-docs", "--api-key", "dp_live_abc123"]
    }
  }
}

Tool categories

The 24 MCP tools cover content CRUD (6), discovery & RAG (5), quality (2), settings (2), workspace management (2), versioning (2), export (1), AI writing (1), activity (1), and comments (2).

Key highlights:

• write_page — smart upsert that creates or updates automatically, so AI agents never need to check if a page exists first
• get_context — RAG-optimized bundle returning a page with its parent, siblings, wikilink targets, and workspace metadata in a single call
• get_manifest — complete workspace overview with cross-page link relationships for AI agents to understand structure at a glance
• quality_scan — automated quality scoring (0–100) with detailed findings

See the MCP Server guide for the complete tool reference, authentication details, rate limits, and troubleshooting.

Feature gating

AI features are available on all plans during the beta period. In future releases, advanced AI features (doc chat, custom models) may be restricted to paid plans.

Privacy

• Your documentation content is sent to the configured AI provider for processing
• No content is stored by DocPlatform beyond the API request lifecycle
• AI providers may have their own data retention policies — review your provider’s terms
• AI features are entirely optional and disabled by default