Skip to main content
open-index mcp runs an MCP server (stdio) exposing the brain to any MCP client — read and write by default.

​
The tools

  • The server publishes dynamic, brain-specific instructions as part of the agent prompt so supporting hosts can navigate the domain before the first tool call.

navigation_guidelines()

Refresh the domain guide after the index or schema changes — reports doc_types, fields, and the relationship vocabulary of your brain.

search_brain(query, doc_types, limit)

Retrieve domain context by query, optionally scoped to doc_types.

get_entity(id)

Fetch a single entity by its <doc_type>:<slug> id.

put_entity(...) / put_entities([...])

Add or update entities — validated, honoring the storage policy. put_entities writes a whole batch in one call with a shared provenance block.

create_doc_type(...)

Define a new concept from the agent side.

​
Read-only mode

Use open-index mcp --read-only (or open-index serve --read-only) to opt out when an agent should retrieve domain context but never maintain it.

​
Local context-fetch analytics

CLI and MCP searches, entity fetches, and navigation-guide reads are recorded in the user’s local state directory (~/.local/state/open-index/), outside the brain checkout. The Analytics tab shows fetch counts by client/operation, frequently fetched queries or entity IDs, latency, failures, zero-result searches, and recent activity.
This file stays local and is never sent to Open Index’s creators.

​
Claude Code conveniences

open-index init includes optional Claude Code conveniences: .mcp.json, a CLAUDE.md describing durable editing workflows (not runtime navigation), and an edit-brain skill. They are one client integration, not a requirement for building legal, marketing, support, or other specialized agents on Open Index.

​
Portable agent setup skill

skills/setup-open-index/SKILL.md follows the portable Agent Skills SKILL.md format used by agent runtimes including OpenClaw, Hermes, and Claude Code. Give or install this skill in the selected runtime when the agent should set up Open Index itself. It covers installation, domain-brain initialization, generic MCP wiring, default read/write verification, the --read-only opt-out, and production guardrails.

​
Connecting a client

For the exact config block per client (Claude Code, Claude Desktop, Cursor) and the remote HTTP path, see Deployment → Connecting your agent.