Installation & Setup

Install allye-mcp and connect it to Claude Code, Cursor, Copilot, or any MCP-compatible agent.

Prerequisites

Python 3.10+
A Allye account (sign up free)
A Personal Access Token from your profile settings

Install

# pipx (recommended — isolated environment)
pipx install allye-mcp

# pip
pip install allye-mcp

# verify
allye-mcp --version

Get your API key

Sign in at app.allye.devshire.app
Go to Profile → API Keys
Click New key, copy the value (fxpat_...)
Export it in your shell:

export ALLYE_API_KEY=fxpat_your_token_here

Add this to your shell profile (~/.bashrc, ~/.zshrc, ~/.config/fish/config.fish) so it persists.

Connect to your agent

Claude Code

// ~/.claude/settings.json
{
  "mcpServers": {
    "allye": {
      "command": "allye-mcp",
      "env": {
        "ALLYE_API_KEY": "fxpat_your_token_here"
      }
    }
  }
}

Or use the CLI shortcut:

claude mcp add allye -- allye-mcp

Restart Claude Code. You'll see allye · connected · 56 actions registered.

Cursor

// ~/.cursor/mcp.json
{
  "mcpServers": {
    "allye": {
      "command": "allye-mcp",
      "env": { "ALLYE_API_KEY": "fxpat_your_token_here" }
    }
  }
}

Windsurf

// ~/.codeium/windsurf/mcp_config.json
{
  "mcpServers": {
    "allye": {
      "command": "allye-mcp",
      "env": { "ALLYE_API_KEY": "fxpat_your_token_here" }
    }
  }
}

GitHub Copilot (VS Code)

// VS Code settings.json
{
  "github.copilot.chat.mcpServers": {
    "allye": {
      "command": "allye-mcp",
      "env": { "ALLYE_API_KEY": "fxpat_your_token_here" }
    }
  }
}

Other agents

All MCP-compatible agents follow the same stdio pattern. Point to the allye-mcp binary with ALLYE_API_KEY in the environment. Refer to each agent's docs for the config file location.

allye-plugin (no PAT needed)

For Claude Code users, allye-plugin handles OAuth authentication automatically:

/plugin marketplace add allye-assistant/allye-plugin

Environment variables

Variable	Required	Description
`ALLYE_API_KEY`	Yes (unless OAuth)	Personal Access Token
`ALLYE_API_URL`	No	Override API base URL
`ALLYE_LOG_LEVEL`	No	`debug` / `info` / `warn` / `error`
`ALLYE_TIMEOUT`	No	Request timeout in seconds (default: 30)

Verify

Ask your agent initialize allye. The response should list your user, tenant, available teams, and the 12 tool categories.