avarole-mcp 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- avarole_mcp-0.1.0/.gitignore +6 -0
- avarole_mcp-0.1.0/CHANGELOG.md +4 -0
- avarole_mcp-0.1.0/LICENSE +204 -0
- avarole_mcp-0.1.0/PKG-INFO +110 -0
- avarole_mcp-0.1.0/README.md +84 -0
- avarole_mcp-0.1.0/avarole_mcp/__init__.py +7 -0
- avarole_mcp-0.1.0/avarole_mcp/__main__.py +46 -0
- avarole_mcp-0.1.0/avarole_mcp/client.py +80 -0
- avarole_mcp-0.1.0/avarole_mcp/py.typed +0 -0
- avarole_mcp-0.1.0/avarole_mcp/server.py +322 -0
- avarole_mcp-0.1.0/avarole_mcp/version.py +1 -0
- avarole_mcp-0.1.0/pyproject.toml +54 -0
- avarole_mcp-0.1.0/tests/__init__.py +0 -0
- avarole_mcp-0.1.0/tests/conftest.py +167 -0
- avarole_mcp-0.1.0/tests/test_cli.py +29 -0
- avarole_mcp-0.1.0/tests/test_stdio.py +109 -0
- avarole_mcp-0.1.0/tests/test_tools.py +192 -0
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
203
|
+
|
|
204
|
+
Copyright 2026 Avarole
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: avarole-mcp
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: MCP server for Avarole: let Claude, ChatGPT and Cursor look up agents, call history and support tickets, and work the queue
|
|
5
|
+
Project-URL: Homepage, https://avarole.com
|
|
6
|
+
Project-URL: Source, https://github.com/Sbaig3229/avarole-mcp
|
|
7
|
+
Author-email: Avarole <support@avarole.com>
|
|
8
|
+
License-Expression: Apache-2.0
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Keywords: avarole,claude,cursor,mcp,model-context-protocol,support,tickets,voice-agents
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: Programming Language :: Python :: 3
|
|
13
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
18
|
+
Requires-Python: >=3.10
|
|
19
|
+
Requires-Dist: httpx>=0.27
|
|
20
|
+
Requires-Dist: mcp>=1.2
|
|
21
|
+
Provides-Extra: test
|
|
22
|
+
Requires-Dist: anyio; extra == 'test'
|
|
23
|
+
Requires-Dist: pytest-asyncio>=0.23; extra == 'test'
|
|
24
|
+
Requires-Dist: pytest>=8; extra == 'test'
|
|
25
|
+
Description-Content-Type: text/markdown
|
|
26
|
+
|
|
27
|
+
<!-- mcp-name: io.github.Sbaig3229/avarole-mcp -->
|
|
28
|
+
# avarole-mcp
|
|
29
|
+
|
|
30
|
+
An [MCP](https://modelcontextprotocol.io) server for [Avarole](https://avarole.com). It lets Claude, Cursor and other
|
|
31
|
+
MCP clients look at your Avarole account and work your support queue:
|
|
32
|
+
|
|
33
|
+
- **Agents**: list them, read their instructions and settings, and (if you allow it) change a prompt, name or voice.
|
|
34
|
+
- **Calls**: recent calls with length, sentiment, rating and a summary; totals for the last N days.
|
|
35
|
+
- **Support tickets**: list and filter them (open, unassigned, by person, by priority, by words), read a whole
|
|
36
|
+
conversation, see who is holding how many, and (if you allow it) change status, priority, assignee and tags, add
|
|
37
|
+
private notes, and reply to the customer.
|
|
38
|
+
|
|
39
|
+
Ask things like *"Which urgent tickets have nobody on them?"*, *"Summarise yesterday's calls that went badly"* or
|
|
40
|
+
*"Assign ticket 412 to Sue and add a note that I called the customer"*.
|
|
41
|
+
|
|
42
|
+
## Set it up
|
|
43
|
+
|
|
44
|
+
You need an **account API key**: in Avarole open **Developer → API keys → Create key**. (Not an agent's embed key,
|
|
45
|
+
which is meant for websites and is refused here.)
|
|
46
|
+
|
|
47
|
+
**Claude Desktop** (`claude_desktop_config.json`) and **Cursor** (`~/.cursor/mcp.json`):
|
|
48
|
+
|
|
49
|
+
```json
|
|
50
|
+
{
|
|
51
|
+
"mcpServers": {
|
|
52
|
+
"avarole": {
|
|
53
|
+
"command": "uvx",
|
|
54
|
+
"args": ["avarole-mcp"],
|
|
55
|
+
"env": { "AVAROLE_API_KEY": "sk_..." }
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**Claude Code**:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
claude mcp add avarole --env AVAROLE_API_KEY=sk_... -- uvx avarole-mcp
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
(`uvx` comes with [uv](https://docs.astral.sh/uv/). Or `pip install avarole-mcp` and use the command `avarole-mcp`.)
|
|
68
|
+
|
|
69
|
+
## It reads by default
|
|
70
|
+
|
|
71
|
+
| Setting | What it turns on |
|
|
72
|
+
|---|---|
|
|
73
|
+
| nothing | Reading: agents, calls, tickets, workload, statistics. |
|
|
74
|
+
| `AVAROLE_MCP_WRITE=1` (or `--write`) | Changing: update a ticket, add a private note, change an agent. |
|
|
75
|
+
| `AVAROLE_MCP_REPLIES=1` (or `--replies`, needs write) | **Emailing customers** from a ticket. Off unless you ask for it. |
|
|
76
|
+
|
|
77
|
+
Add the setting to the `env` block above. Tools that change things say so in their description, and clients such as
|
|
78
|
+
Claude ask you before running them.
|
|
79
|
+
|
|
80
|
+
## Safety
|
|
81
|
+
|
|
82
|
+
- 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
|
|
83
|
+
agent's settings are never shown.
|
|
84
|
+
- Ticket and call text comes from customers. The assistant is told to treat it as data. Keep replies off unless you
|
|
85
|
+
want them, and read what the assistant is about to send.
|
|
86
|
+
- An account API key can do everything the API allows for your account, so keep it private and revoke it on the
|
|
87
|
+
Developer page if it leaks.
|
|
88
|
+
- 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.
|
|
89
|
+
|
|
90
|
+
## Tools
|
|
91
|
+
|
|
92
|
+
`avarole_list_agents`, `avarole_get_agent`, `avarole_list_calls`, `avarole_call_stats`, `avarole_list_tickets`,
|
|
93
|
+
`avarole_get_ticket`, `avarole_ticket_stats`, `avarole_team_workload`, `avarole_list_team`; with write access
|
|
94
|
+
`avarole_update_ticket`, `avarole_add_ticket_note`, `avarole_update_agent`; with replies `avarole_reply_to_ticket`.
|
|
95
|
+
|
|
96
|
+
## Other settings
|
|
97
|
+
|
|
98
|
+
- `AVAROLE_BASE_URL` (default `https://app.avarole.com`).
|
|
99
|
+
- `--transport streamable-http` serves over HTTP on this machine (`127.0.0.1`) for tools that cannot start a process.
|
|
100
|
+
It has no sign-in of its own: do not expose it to a network. Hosted use (for example by ChatGPT connectors) would
|
|
101
|
+
need OAuth, which this version does not include.
|
|
102
|
+
|
|
103
|
+
## Development
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
pip install -e ".[test]"
|
|
107
|
+
pytest
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Apache-2.0. © Avarole.
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
<!-- mcp-name: io.github.Sbaig3229/avarole-mcp -->
|
|
2
|
+
# avarole-mcp
|
|
3
|
+
|
|
4
|
+
An [MCP](https://modelcontextprotocol.io) server for [Avarole](https://avarole.com). It lets Claude, Cursor and other
|
|
5
|
+
MCP clients look at your Avarole account and work your support queue:
|
|
6
|
+
|
|
7
|
+
- **Agents**: list them, read their instructions and settings, and (if you allow it) change a prompt, name or voice.
|
|
8
|
+
- **Calls**: recent calls with length, sentiment, rating and a summary; totals for the last N days.
|
|
9
|
+
- **Support tickets**: list and filter them (open, unassigned, by person, by priority, by words), read a whole
|
|
10
|
+
conversation, see who is holding how many, and (if you allow it) change status, priority, assignee and tags, add
|
|
11
|
+
private notes, and reply to the customer.
|
|
12
|
+
|
|
13
|
+
Ask things like *"Which urgent tickets have nobody on them?"*, *"Summarise yesterday's calls that went badly"* or
|
|
14
|
+
*"Assign ticket 412 to Sue and add a note that I called the customer"*.
|
|
15
|
+
|
|
16
|
+
## Set it up
|
|
17
|
+
|
|
18
|
+
You need an **account API key**: in Avarole open **Developer → API keys → Create key**. (Not an agent's embed key,
|
|
19
|
+
which is meant for websites and is refused here.)
|
|
20
|
+
|
|
21
|
+
**Claude Desktop** (`claude_desktop_config.json`) and **Cursor** (`~/.cursor/mcp.json`):
|
|
22
|
+
|
|
23
|
+
```json
|
|
24
|
+
{
|
|
25
|
+
"mcpServers": {
|
|
26
|
+
"avarole": {
|
|
27
|
+
"command": "uvx",
|
|
28
|
+
"args": ["avarole-mcp"],
|
|
29
|
+
"env": { "AVAROLE_API_KEY": "sk_..." }
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
**Claude Code**:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
claude mcp add avarole --env AVAROLE_API_KEY=sk_... -- uvx avarole-mcp
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
(`uvx` comes with [uv](https://docs.astral.sh/uv/). Or `pip install avarole-mcp` and use the command `avarole-mcp`.)
|
|
42
|
+
|
|
43
|
+
## It reads by default
|
|
44
|
+
|
|
45
|
+
| Setting | What it turns on |
|
|
46
|
+
|---|---|
|
|
47
|
+
| nothing | Reading: agents, calls, tickets, workload, statistics. |
|
|
48
|
+
| `AVAROLE_MCP_WRITE=1` (or `--write`) | Changing: update a ticket, add a private note, change an agent. |
|
|
49
|
+
| `AVAROLE_MCP_REPLIES=1` (or `--replies`, needs write) | **Emailing customers** from a ticket. Off unless you ask for it. |
|
|
50
|
+
|
|
51
|
+
Add the setting to the `env` block above. Tools that change things say so in their description, and clients such as
|
|
52
|
+
Claude ask you before running them.
|
|
53
|
+
|
|
54
|
+
## Safety
|
|
55
|
+
|
|
56
|
+
- 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
|
|
57
|
+
agent's settings are never shown.
|
|
58
|
+
- Ticket and call text comes from customers. The assistant is told to treat it as data. Keep replies off unless you
|
|
59
|
+
want them, and read what the assistant is about to send.
|
|
60
|
+
- An account API key can do everything the API allows for your account, so keep it private and revoke it on the
|
|
61
|
+
Developer page if it leaks.
|
|
62
|
+
- 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.
|
|
63
|
+
|
|
64
|
+
## Tools
|
|
65
|
+
|
|
66
|
+
`avarole_list_agents`, `avarole_get_agent`, `avarole_list_calls`, `avarole_call_stats`, `avarole_list_tickets`,
|
|
67
|
+
`avarole_get_ticket`, `avarole_ticket_stats`, `avarole_team_workload`, `avarole_list_team`; with write access
|
|
68
|
+
`avarole_update_ticket`, `avarole_add_ticket_note`, `avarole_update_agent`; with replies `avarole_reply_to_ticket`.
|
|
69
|
+
|
|
70
|
+
## Other settings
|
|
71
|
+
|
|
72
|
+
- `AVAROLE_BASE_URL` (default `https://app.avarole.com`).
|
|
73
|
+
- `--transport streamable-http` serves over HTTP on this machine (`127.0.0.1`) for tools that cannot start a process.
|
|
74
|
+
It has no sign-in of its own: do not expose it to a network. Hosted use (for example by ChatGPT connectors) would
|
|
75
|
+
need OAuth, which this version does not include.
|
|
76
|
+
|
|
77
|
+
## Development
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
pip install -e ".[test]"
|
|
81
|
+
pytest
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Apache-2.0. © Avarole.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import argparse
|
|
2
|
+
import logging
|
|
3
|
+
import os
|
|
4
|
+
import sys
|
|
5
|
+
|
|
6
|
+
from .client import DEFAULT_BASE_URL, Avarole, AvaroleError
|
|
7
|
+
from .server import build_server
|
|
8
|
+
from .version import __version__
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def _on(name: str) -> bool:
|
|
12
|
+
return os.environ.get(name, "").strip().lower() in ("1", "true", "yes", "on")
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
def main(argv=None) -> int:
|
|
16
|
+
p = argparse.ArgumentParser(
|
|
17
|
+
prog="avarole-mcp", description="MCP server for Avarole (agents, calls, support tickets)."
|
|
18
|
+
)
|
|
19
|
+
p.add_argument("--transport", choices=["stdio", "streamable-http"], default="stdio")
|
|
20
|
+
p.add_argument("--write", action="store_true", help="allow changes (same as AVAROLE_MCP_WRITE=1)")
|
|
21
|
+
p.add_argument(
|
|
22
|
+
"--replies", action="store_true", help="allow emailing customers; needs --write (same as AVAROLE_MCP_REPLIES=1)"
|
|
23
|
+
)
|
|
24
|
+
p.add_argument("--version", action="version", version="avarole-mcp " + __version__)
|
|
25
|
+
a = p.parse_args(argv)
|
|
26
|
+
logging.getLogger("httpx").setLevel(logging.WARNING) # request lines are noise, and tickets are private
|
|
27
|
+
write, replies = a.write or _on("AVAROLE_MCP_WRITE"), a.replies or _on("AVAROLE_MCP_REPLIES")
|
|
28
|
+
if replies and not write:
|
|
29
|
+
print("avarole-mcp: replies need write access too (set AVAROLE_MCP_WRITE=1).", file=sys.stderr)
|
|
30
|
+
return 2
|
|
31
|
+
try:
|
|
32
|
+
api = Avarole(os.environ.get("AVAROLE_API_KEY", ""), os.environ.get("AVAROLE_BASE_URL", DEFAULT_BASE_URL))
|
|
33
|
+
except AvaroleError as exc:
|
|
34
|
+
print(
|
|
35
|
+
"avarole-mcp: %s Create an account API key on the Developer page of app.avarole.com and set it." % exc,
|
|
36
|
+
file=sys.stderr,
|
|
37
|
+
)
|
|
38
|
+
return 2
|
|
39
|
+
server = build_server(api, write=write, replies=replies)
|
|
40
|
+
print("avarole-mcp %s: %s" % (__version__, "reading and changing" if write else "read-only"), file=sys.stderr)
|
|
41
|
+
server.run(a.transport)
|
|
42
|
+
return 0
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
if __name__ == "__main__":
|
|
46
|
+
raise SystemExit(main())
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
"""A small, careful client for Avarole's REST API. The API key is only ever sent as the X-API-Key header."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from typing import Any, Optional
|
|
6
|
+
|
|
7
|
+
import httpx
|
|
8
|
+
|
|
9
|
+
from .version import __version__
|
|
10
|
+
|
|
11
|
+
DEFAULT_BASE_URL = "https://app.avarole.com"
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class AvaroleError(Exception):
|
|
15
|
+
"""Something the person asking can be told in one sentence."""
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
def _explain(status: int, detail: Any) -> str:
|
|
19
|
+
msg = detail.get("message") if isinstance(detail, dict) else detail
|
|
20
|
+
msg = str(msg or "").strip()
|
|
21
|
+
if status == 401:
|
|
22
|
+
return "Avarole refused the API key (wrong or revoked). Create an account API key on the Developer page."
|
|
23
|
+
if status == 403:
|
|
24
|
+
return msg or "This API key is not allowed to do that. Embed keys cannot be used here: use an account API key."
|
|
25
|
+
if status == 404:
|
|
26
|
+
return msg or "Not found (check the id)."
|
|
27
|
+
if status == 402:
|
|
28
|
+
return msg or "The account has no minutes or credits left for this."
|
|
29
|
+
if status == 429:
|
|
30
|
+
return "Avarole is rate limiting this key. Try again in a minute."
|
|
31
|
+
if status >= 500:
|
|
32
|
+
return "Avarole is not available right now (%d). Try again shortly." % status
|
|
33
|
+
return msg or "Avarole returned an error (%d)." % status
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
class Avarole:
|
|
37
|
+
def __init__(
|
|
38
|
+
self,
|
|
39
|
+
api_key: str,
|
|
40
|
+
base_url: str = DEFAULT_BASE_URL,
|
|
41
|
+
*,
|
|
42
|
+
timeout: float = 30.0,
|
|
43
|
+
transport: Optional[httpx.AsyncBaseTransport] = None,
|
|
44
|
+
) -> None:
|
|
45
|
+
if not api_key:
|
|
46
|
+
raise AvaroleError("AVAROLE_API_KEY is not set.")
|
|
47
|
+
self._http = httpx.AsyncClient(
|
|
48
|
+
base_url=base_url.rstrip("/"),
|
|
49
|
+
timeout=timeout,
|
|
50
|
+
transport=transport,
|
|
51
|
+
headers={"X-API-Key": api_key, "User-Agent": "avarole-mcp/%s" % __version__, "Accept": "application/json"},
|
|
52
|
+
)
|
|
53
|
+
|
|
54
|
+
async def aclose(self) -> None:
|
|
55
|
+
await self._http.aclose()
|
|
56
|
+
|
|
57
|
+
async def request(
|
|
58
|
+
self, method: str, path: str, *, params: Optional[dict] = None, json: Optional[dict] = None
|
|
59
|
+
) -> Any:
|
|
60
|
+
try:
|
|
61
|
+
r = await self._http.request(
|
|
62
|
+
method, path, params={k: v for k, v in (params or {}).items() if v not in (None, "")}, json=json
|
|
63
|
+
)
|
|
64
|
+
except httpx.TimeoutException:
|
|
65
|
+
raise AvaroleError("Avarole did not answer in time.") from None
|
|
66
|
+
except httpx.HTTPError:
|
|
67
|
+
raise AvaroleError("Could not reach Avarole.") from None
|
|
68
|
+
if r.status_code >= 400:
|
|
69
|
+
try:
|
|
70
|
+
detail = r.json().get("detail")
|
|
71
|
+
except Exception:
|
|
72
|
+
detail = None
|
|
73
|
+
raise AvaroleError(_explain(r.status_code, detail))
|
|
74
|
+
try:
|
|
75
|
+
return r.json()
|
|
76
|
+
except ValueError:
|
|
77
|
+
raise AvaroleError("Avarole sent a reply that is not JSON.") from None
|
|
78
|
+
|
|
79
|
+
def get(self, path: str, **params: Any) -> Any:
|
|
80
|
+
return self.request("GET", path, params=params)
|
|
File without changes
|