txtai MCP API

Official

txtai exposes configured API endpoints as MCP tools for semantic search, retrieval pipelines and workflows through its Python API server.

Remote serverssePythonApache-2.0

What is the txtai MCP API MCP Server?

txtai exposes configured API endpoints as MCP tools for semantic search, retrieval pipelines and workflows through its Python API server.

MCP follows the API configuration

txtai is a Python framework for embeddings, retrieval, pipelines and workflows. Its API can export enabled endpoints as MCP tools. This is a real server configuration, rather than a fixed collection of tools supplied to every user: the API configuration and the resources loaded behind each endpoint determine the usable interface.

Enable the MCP route

Add mcp: true to the API YAML configuration and start the configured API application. A dictionary can supply HTTP-client and FastApiMCP options when defaults are unsuitable. The resulting route is /mcp. Install the API dependencies and configure the index or pipelines needed by the task before connecting an assistant.

Check transport compatibility

The documented implementation mounts the route through FastApiMCP's mount() interface, which uses SSE. Select a compatible client and inspect the installed dependency version before assuming that a generic HTTP connector will work. A local API URL is an example deployment address, not a public hosted txtai endpoint.

Evaluate retrieval before generation

Build a small index with passages whose origin is known. Query it through the API and MCP, then compare the returned text and metadata with the source documents. Add a generation or workflow endpoint only when its input and result contract is clear. Configure API authentication and exposed endpoints deliberately; installing txtai alone does not activate every framework capability.

Project documentation

Repository and setup guide

How to install the txtai MCP API MCP Server

CONFIG=app.yml uvicorn "txtai.api:app"

Create app.yml with mcp: true and the API resources needed for your task. This command starts the API; connect the client to your instance’s /mcp route.

Configuration

Python 3.11 or later, txtai API dependencies, a configured index or pipeline and an SSE-compatible MCP client.

VariableDescriptionRequired
CONFIGPath to the API YAML configuration, including the MCP setting and enabled pipelines or index.Yes

Example prompts to try

  • “Use Txtai to Built.”
  • “Use Txtai to Notebook.”
  • “Use Txtai to Component.”

Frequently asked questions

Enabled API endpoints are converted into MCP tools. The actual list follows your YAML configuration, loaded resources and API settings.