MCP commands
MCP commands
Reference for indexed mcp * (and MCP tools). For global indexed options (before the subcommand), see Other commands — global options (top-level). For walkthroughs, see MCP Integration, Claude Plugin, and MCP Setup.
Help vs. -h
indexed mcpandindexed mcp rundefine-h/--hostas the bind address forhttp,sse, andstreamable-http. It is not a short form of “show help.”- Help:
indexed mcp run --help,indexed mcp --help, orindexed --help(top-level usage uses--help).
indexed mcp (command group)
indexed mcp --help lists subcommands run, dev, and inspect, plus docs (opens MCP documentation in your browser). The group also accepts the same transport/host/port/log-level options as mcp run. You can pass those flags before the subcommand or on mcp run — for example:
indexed mcp --transport http --host 127.0.0.1 --port 8000 run
indexed mcp run --transport http --host 127.0.0.1 --port 8000indexed mcp inspect
Print a summary of registered tools, resources, and prompts (human-readable by default). Use this as a quick smoke test after install.
indexed mcp inspect
indexed --simple-output mcp inspectindexed mcp run
Start the MCP server.
indexed mcp run [flags]| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
-t, --transport | string | No | stdio | stdio, http, sse, or streamable-http |
-h, --host | string | No | 127.0.0.1 | Bind address for HTTP-based transports (not the same as --help on the top-level indexed command) |
-p, --port | int | No | 8000 | Port for HTTP/SSE/streamable-http |
--log-level | string | No | INFO | DEBUG, INFO, WARNING, or ERROR |
--no-banner | flag | No | off | Disable the startup banner |
Examples:
# Default stdio (for Claude Desktop, Cursor, Cline)
indexed mcp run
# HTTP server on default port
indexed mcp run --transport http --port 8000
# HTTP on all interfaces (for Docker)
indexed mcp run --transport http --host 0.0.0.0 --port 8000Healthy startup output (stdio):
Indexed MCP server started
Transport: stdio
Collections available: my-docs, eng-tickets
Waiting for client connection...indexed mcp dev
Start the MCP server with the MCP Inspector browser UI for testing and debugging.
indexed mcp dev
indexed mcp dev --ui-port 3000 --server-port 8001| Flag | Description |
|---|---|
--ui-port | Port for the MCP Inspector UI |
--server-port | Port for the MCP Inspector proxy server |
--inspector-version | MCP Inspector version to use |
Opens a local browser UI where you can call search and search_collection directly and inspect request/response payloads. See Debugging MCP for a walkthrough.
indexed mcp inspect
Print a summary of registered tools, resources, and prompts (human-readable by default).
indexed mcp inspect
indexed --simple-output mcp inspectWith --simple-output on the top-level indexed command, the summary includes a small JSON object (counts and server metadata) suitable for scripts.
Transport options
| Transport | Command | Use Case |
|---|---|---|
| stdio (default) | indexed mcp run | Claude, Cursor, Copilot, Codex, and other stdio MCP clients |
| HTTP | indexed mcp run --transport http --port 8000 | Docker, remote access, HTTP tunnels |
| SSE | indexed mcp run --transport sse | Server-Sent Events streaming clients |
| Streamable HTTP | indexed mcp run --transport streamable-http | Newer HTTP streaming protocol |
MCP tools
Indexed exposes two tools via the Model Context Protocol.
search
Search across all collections simultaneously.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Natural language search query |
Example call
{
"tool": "search",
"arguments": {
"query": "how to handle authentication timeouts"
}
}Response shape
Both tools return JSON with aggregate counts and a results array. Each item typically includes fields such as rank, relevance_score, collection, document_id, document_url, chunk_number, and text (matched chunk). Exact keys may vary slightly by connector; use indexed mcp inspect or the Inspector to confirm live schemas.
search_collection
Search a specific collection by name.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
collection | string | Yes | Name of the collection to search |
query | string | Yes | Natural language search query |
Example call
{
"tool": "search_collection",
"arguments": {
"collection": "eng-tickets",
"query": "rate limiting implementation"
}
}Response
Same shape as search, but every hit is from the collection you passed in.
MCP resources
Read-only resource URIs expose collection metadata to MCP clients.
| URI pattern | Name | Returns |
|---|---|---|
resource://collections/{_all} | CollectionsList | All collection names |
resource://collections/status/{_all} | CollectionsStatusList | Status for every collection |
resource://collections/{name} | CollectionStatus | Status for one collection |
Status payloads include fields such as name, document/chunk counts, updated_time, last_modified_document_time, indexers, index_size, source_type, relative_path, and disk_size_bytes (some fields depend on config — e.g. include_index_size in [mcp]).
MCP server configuration ([mcp])
Optional defaults for the MCP server (see your Indexed config TOML):
[mcp]
host = "localhost"
port = 8000
log_level = "WARNING"
enable_async_pool = false
include_index_size = falseClient setup
- MCP Integration
- Claude Plugin
- MCP Setup
- Quick Start (Docker tab) for container-style HTTP transport