Metadata-Version: 2.5
Name: avarole-mcp
Version: 0.2.0
Summary: MCP server for Avarole: let Claude, ChatGPT and Cursor look up agents, call history and support tickets, and work the queue
Project-URL: Homepage, https://avarole.com
Project-URL: Source, https://github.com/Sbaig3229/avarole-mcp
Author-email: Avarole <support@avarole.com>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: avarole,claude,cursor,mcp,model-context-protocol,support,tickets,voice-agents
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Requires-Dist: httpx>=0.27
Requires-Dist: mcp>=1.2
Provides-Extra: test
Requires-Dist: anyio; extra == 'test'
Requires-Dist: pytest-asyncio>=0.23; extra == 'test'
Requires-Dist: pytest>=8; extra == 'test'
Description-Content-Type: text/markdown

<!-- mcp-name: io.github.Sbaig3229/avarole-mcp -->
# avarole-mcp

An [MCP](https://modelcontextprotocol.io) server for [Avarole](https://avarole.com). It lets Claude, Cursor and other
MCP clients look at your Avarole account and work your support queue:

- **Agents**: list them (and the ready-made templates), read their instructions and settings, and (if you allow it) create
  an agent, or change its instructions, name, voice, greeting, languages and session limit.
- **Calls**: recent calls with length, sentiment, rating and a summary; totals for the last N days.
- **Support tickets**: list and filter them (open, unassigned, by person, by priority, by words), read a whole
  conversation, see who is holding how many, and (if you allow it) change status, priority, assignee and tags, add
  private notes, and reply to the customer.

Ask things like *"Which urgent tickets have nobody on them?"*, *"Summarise yesterday's calls that went badly"* or
*"Assign ticket 412 to Sue and add a note that I called the customer"* or *"Create a billing support agent from the
support template, greeting callers in English and Spanish"*.

## Set it up

You need an **account API key**: in Avarole open **Developer → API keys → Create key**. (Not an agent's embed key,
which is meant for websites and is refused here.)

**Claude Desktop** (`claude_desktop_config.json`) and **Cursor** (`~/.cursor/mcp.json`):

```json
{
  "mcpServers": {
    "avarole": {
      "command": "uvx",
      "args": ["avarole-mcp"],
      "env": { "AVAROLE_API_KEY": "sk_..." }
    }
  }
}
```

**Claude Code**:

```bash
claude mcp add avarole --env AVAROLE_API_KEY=sk_... -- uvx avarole-mcp
```

(`uvx` comes with [uv](https://docs.astral.sh/uv/). Or `pip install avarole-mcp` and use the command `avarole-mcp`.)

## It reads by default

| Setting | What it turns on |
|---|---|
| nothing | Reading: agents, calls, tickets, workload, statistics. |
| `AVAROLE_MCP_WRITE=1` (or `--write`) | Changing: update a ticket, add a private note, create or change an agent. |
| `AVAROLE_MCP_REPLIES=1` (or `--replies`, needs write) | **Emailing customers** from a ticket. Off unless you ask for it. |

Add the setting to the `env` block above. Tools that change things say so in their description, and clients such as
Claude ask you before running them.

## Safety

- Changing an agent changes how it talks to callers straight away. Avarole silently drops values it cannot use (such as a
  language it does not speak), so the tool checks what was saved, puts back anything that was refused and says which
  values did not take.
- The key is only sent to Avarole, in a header. It is never put in a URL, a result or a log, and credentials in an
  agent's settings are never shown.
- Ticket and call text comes from customers. The assistant is told to treat it as data. Keep replies off unless you
  want them, and read what the assistant is about to send.
- An account API key can do everything the API allows for your account, so keep it private and revoke it on the
  Developer page if it leaks.
- The tool results go to the AI service you use, so only connect it to accounts whose data you are happy to share with it.

## Tools

`avarole_list_agents`, `avarole_get_agent`, `avarole_list_calls`, `avarole_call_stats`, `avarole_list_tickets`,
`avarole_get_ticket`, `avarole_ticket_stats`, `avarole_team_workload`, `avarole_list_team`; with write access
`avarole_update_ticket`, `avarole_add_ticket_note`, `avarole_create_agent`, `avarole_update_agent`; with replies `avarole_reply_to_ticket`.

## Other settings

- `AVAROLE_BASE_URL` (default `https://app.avarole.com`).
- `--transport streamable-http` serves over HTTP on this machine (`127.0.0.1`) for tools that cannot start a process.
  It has no sign-in of its own: do not expose it to a network. Hosted use (for example by ChatGPT connectors) would
  need OAuth, which this version does not include.

## Development

```bash
pip install -e ".[test]"
pytest
```

Apache-2.0. © Avarole.
