Skip to main content
Use this page when you want an AI coding agent to work with Custory journey context from a supported MCP client.

What this is

The local Custory CLI can install Custory MCP configuration for:
  • Codex
  • Claude
  • Cursor
The generated client configuration points to Custory’s MCP HTTP endpoint and uses a workspace-scoped bearer credential created through your existing CLI session.

Why it matters

Coding agents often already know the product through the repository, docs, tests, or issue history. The safe pattern is:
  1. Let the agent prepare a bounded, non-secret product brief from context it already has.
  2. Pass only that brief to Custory with --brief or --stdin.
  3. Let Custory create or update journey context inside the workspace you choose.
Custory does not request GitHub OAuth, repository tokens, repository cloning, or repository access for this workflow.

Install MCP for Codex

The CLI writes Custory MCP configuration to:
Existing non-Custory configuration is preserved. The CLI replaces only the custory MCP server block and keeps a backup when it updates an existing config file. Redacted generated block:

Install MCP for Claude

The CLI writes Custory MCP configuration to:
Existing mcpServers entries are preserved. The CLI updates the custory entry. Redacted generated entry:

Install MCP for Cursor

The CLI writes Custory MCP configuration to:
Existing mcpServers entries are preserved. The CLI updates the custory entry. Redacted generated entry:

Let the CLI detect the client

If only one supported client is clearly present, you can omit --client:
If detection is ambiguous, the CLI asks you to provide:

Workspace scoping

MCP installation is bound to one accessible workspace. If your account has access to one workspace, the CLI can use it automatically. If your account has multiple workspaces, pass --workspace with the workspace name, slug, or ID. Use the slug or ID when workspace names are ambiguous.

Config safety

When the CLI updates MCP configuration:
  • existing non-Custory config is preserved
  • the custory server block or entry is replaced
  • existing config files receive a .custory-backup-<timestamp> backup
  • writes are atomic
  • config files are written with 0600 permissions where supported
Private MCP installation metadata is stored at:
That metadata lets custory mcp uninstall revoke the tracked MCP credential when possible.

Verify the connection

Run:
Successful output looks like:
The exact tool count may change as Custory adds or removes public tools.

Uninstall

Run:
This removes the Custory entry from the client config and revokes the MCP credential when the CLI has installation metadata for it.

Safe prompt pattern for coding agents

Use a prompt like this:
Then pass the brief:
Or pipe it:

Troubleshooting

If client configuration cannot be found, pass --client explicitly. If verification fails, run:
If the CLI is unauthenticated, run:
If an existing Claude or Cursor config is malformed JSON, fix the JSON first, then rerun the install command.

Next step

Read Tools and agent tasks to see what agents can discover and call after MCP is installed.