ReadMe and TextMine MCP Quickstart

Connect Codex, Claude, Cursor, Windsurf, ChatGPT, or another MCP-compatible client to TextMine documentation and tools.

TextMine currently exposes two MCP surfaces. They are related, but they solve different jobs.

MCP endpoints

Endpoint	URL	Purpose
ReadMe MCP	https://developers.textmine.com/mcp	Developer-hub MCP for ReadMe docs, OpenAPI schemas, and generated API-reference tools.
TextMine MCP	https://mcp.textmine.com/mcp	Central product MCP endpoint backed by Public API V3 for TextMine Vault, document, record, report, workflow, and agent work.

Use https://mcp.textmine.com/mcp for public setup guides, MCP registries, and broadly shared external clients. Use environment-specific MCP hosts only for private preview, staging validation, or dedicated deployments when TextMine explicitly issues that host.

When to use each MCP

Use ReadMe MCP when the agent needs to search API docs, inspect schemas, or discover endpoint details from developers.textmine.com.
Use TextMine MCP when the agent needs to operate TextMine resources directly through the hosted product tool surface.
Use Public API V3 directly when the client already has an HTTP integration layer and does not need MCP tool discovery. Self-service agents can complete signup and setup entirely through REST.
Use Agent self-service signup first when an autonomous third-party agent needs its own TextMine organization and service-account API key.

OpenAPI and MCP

Use the published API reference at developers.textmine.com/reference. Agents and developers use it for endpoint discovery, SDK generation, typed clients, API-client imports, and exact request/response shapes.

MCP clients do not use OpenAPI as their runtime contract. They initialize a Streamable HTTP session, list tools, and call tools using MCP schemas. Some platforms, including Copilot Studio custom connectors, may need an OpenAPI wrapper around /mcp; that wrapper is platform adapter metadata, not the canonical Public API spec.

Authentication

Public API V3 and the TextMine MCP endpoint require a TextMine API key. Use bearer authentication for direct REST and MCP clients:

Authorization: Bearer tm_your_api_key

Use the alternate API-key header when a platform owns or rewrites the Authorization header, such as some Copilot Studio or Power Platform custom connector flows:

X-TextMine-Api-Key: tm_your_api_key

Create or request a key through TextMine support, an existing organization admin flow, or Agent self-service signup. Store the key in a trusted runtime or secret manager. Do not expose it in prompts, chat messages, task transcripts, or model-visible context.

Generic remote MCP config

Use your MCP client's remote-server syntax. This example shows the two surfaces side by side:

{
  "mcpServers": {
    "textmine-docs": {
      "url": "https://developers.textmine.com/mcp"
    },
    "textmine": {
      "url": "https://mcp.textmine.com/mcp",
      "headers": {
        "Authorization": "Bearer tm_your_api_key"
      }
    }
  }
}

Some clients store headers separately from the MCP server JSON. Follow the client's secret-storage pattern whenever possible. If your client cannot set an Authorization header but can set custom headers, use X-TextMine-Api-Key instead.

Streamable HTTP handshake

The TextMine MCP endpoint uses Streamable HTTP. Direct clients must:

Send initialize to https://mcp.textmine.com/mcp.
Keep the returned mcp-session-id response header.
Send notifications/initialized with mcp-session-id.
Call tools/list or tools/call with mcp-session-id.

A direct tools/call without mcp-session-id is rejected. Many hosted clients handle this handshake automatically; in those clients, enter only the server URL and authentication header.

Copilot Studio and custom connectors

For Copilot Studio custom connectors, set the connector host to mcp.textmine.com, the base path to /mcp, and the scheme to https. If the connector wizard requires API-key auth instead of bearer auth, configure the API key as header X-TextMine-Api-Key.

OAuth marketplace or private-preview packages should still point at https://mcp.textmine.com/mcp; only the authentication flow changes.

Agent self-service signup

Self-service agents do not need MCP for signup. For multitenant, non-enterprise onboarding, use Public API V3:

The signup response creates a TextMine organization, service-account user, encrypted tm_... API key, and billing account. With encrypted credential delivery, the trusted runtime decrypts encryptedApiKey and stores it outside model context. After signup, use REST for Vault creation, document type creation, file upload, tasks/messages, and billing status unless the agent platform specifically wants MCP.

First useful checks

Ask ReadMe MCP for the current Public API V3 docs for Vaults, documents, tags, records, workflows, and agent signup.
Verify the TextMine API key by calling a low-risk endpoint such as the current user/profile or Vault list endpoint.
List Vaults before Vault-scoped actions.
For document workflows, upload/import, poll processing status, then fetch tags, metadata, extracted text, or tag source chunks as needed.
For billing-gated agent organizations, call GET /v3/agent-billing/status before heavy work.