For the complete documentation index, see llms.txt. This page is also available as Markdown.

Client setup

Follow these three steps for Codex CLI, Claude Code, or Cursor Agent. The token stays in your project's local environment; client configuration and AI chat contain only the environment-variable name.

1. Create an access token

First, create a token in authenticated FieldsRaven Settings at /settings within the embedded app. The numeric /shops/<shop-id>/settings/index path is compatibility-only; use the shopless path for bookmarks and instructions.

Choose Read for inspection and verification, or Manage only when the client must create or update Ravens. The plaintext is revealed once. If it is lost, revoke the active token row and create a replacement.

2. Save the token in this project

Add the token manually to a project-root .env using this shape:

FIELDSRAVEN_MCP_TOKEN=fr_mcp_paste-your-token-here

Confirm .env is in .gitignore before adding the token. Never commit .env, and never paste the token into an MCP configuration or AI chat. The .env file is storage, not automatic process loading.

macOS or Linux

From the project root, load the variables into the current terminal:

set -a && source .env && set +a

Start or restart your AI client from this same terminal so it inherits the variable. Missing FIELDSRAVEN_MCP_TOKEN? Add the line to .env manually. Do not ask an AI agent to open or inspect .env.

Windows PowerShell

From the project root, load only the named value into the current PowerShell process:

Start or restart your AI client from this same terminal so it inherits the variable. Missing FIELDSRAVEN_MCP_TOKEN? Add the line to .env manually. Do not ask an AI agent to open or inspect .env.

3. Connect your AI agent

Use the exact project destination and configuration for your client. You can also copy the matching prompt into a new agent session; it contains the complete configuration but never the bearer token.

Codex CLI

Codex CLI 0.145.0

Project destination: .codex/config.toml

Tell Codex CLI:

Claude Code

Claude Code 2.1.220

Project destination: .mcp.json

Tell Claude Code:

Cursor Agent

Cursor Agent 2026.08.04-aaa8809

Project destination: .cursor/mcp.json

Tell Cursor Agent:

The placeholder syntax differs between Claude Code and Cursor Agent. Preserve it exactly. In the fresh client process, confirm that FieldsRaven exposes exactly 11 tools, then call get_app_info. Report the negotiated protocol and server version; do not create, update, or otherwise mutate store data merely to test connectivity.

These versions, destinations, and file shapes are the tested onboarding contract. Live client connection checks are a separate release gate; configuration alone does not prove connectivity.

Last updated