Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.animam.ai/llms.txt

Use this file to discover all available pages before exploring further.

Configure the Animam MCP server for use with Claude Code or other clients.

Prerequisites

  • Node.js 18+
  • An Animam API token with required scopes
  • Claude Code or a compatible MCP client

Claude Code Configuration

Add the configuration to your ~/.claude/settings.json file:
{
  "mcpServers": {
    "animam": {
      "command": "npx",
      "args": ["@animam/mcp"],
      "env": {
        "ANIMAM_API_TOKEN": "ak_your_token",
        "ANIMAM_TENANT": "your-slug"
      }
    }
  }
}
Restart Claude Code to load the server.

Claude Desktop Configuration

  1. Open Claude Desktop settings
  2. Go to Developer > MCP Servers
  3. Add a new server:
{
  "animam": {
    "command": "npx",
    "args": ["@animam/mcp"],
    "env": {
      "ANIMAM_API_TOKEN": "ak_your_token",
      "ANIMAM_TENANT": "your-slug"
    }
  }
}

Environment Variables

VariableRequiredDescription
ANIMAM_API_TOKENYesAPI token with required scopes
ANIMAM_TENANTYesYour tenant slug
ANIMAM_API_URLNoAPI URL (default: https://api.animam.ai)
For full usage, create a token with these scopes:
corpus:read, corpus:write, conversations:read, settings:read, settings:write
For read-only access:
corpus:read, conversations:read, settings:read

Verification

Once configured, test in Claude Code:
You: List the Animam corpus entries

Claude: Here are your corpus entries:
1. FAQ - Hours (segment: contact)
2. Return Policy (segment: checkout)
3. Pricing (segment: pricing)
...

Local Installation (development)

To contribute or debug:
# Clone the repo
git clone https://github.com/animam-ai/mcp-server
cd mcp-server

# Install
npm install

# Configure
cp .env.example .env
# Edit .env with your token

# Run
npm run dev
Configuration for local development:
{
  "mcpServers": {
    "animam-dev": {
      "command": "node",
      "args": ["/path/to/mcp-server/dist/index.js"],
      "env": {
        "ANIMAM_API_TOKEN": "ak_your_token",
        "ANIMAM_TENANT": "your-slug"
      }
    }
  }
}

Troubleshooting

Server won’t start

# Check Node.js
node --version  # Must be >= 18

# Test manually
ANIMAM_API_TOKEN=ak_xxx ANIMAM_TENANT=xxx npx @animam/mcp

Authentication error

Verify your token is valid:
curl https://api.animam.ai/tenants/your-slug \
  -H "Authorization: Bearer ak_your_token"

Tools not available

Check token scopes. A token with corpus:read only won’t have access to corpus_add.