@avallon-labs/mcp 0.0.0
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.
- package/README.md +63 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +3839 -0
- package/dist/index.js.map +1 -0
- package/package.json +56 -0
package/README.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# @avallon-labs/mcp
|
|
2
|
+
|
|
3
|
+
Avallon MCP (Model Context Protocol) server — auto-generated from the same OpenAPI spec as `@avallon-labs/sdk`.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
### Environment variables
|
|
8
|
+
|
|
9
|
+
| Variable | Required | Default | Description |
|
|
10
|
+
| ---------------------- | -------- | -------------------------- | ---------------------------------- |
|
|
11
|
+
| `AVALLON_API_KEY` | Yes\* | — | API key (`x-api-key` header) |
|
|
12
|
+
| `AVALLON_ACCESS_TOKEN` | Yes\* | — | Bearer token (`Authorization`) |
|
|
13
|
+
| `AVALLON_BASE_URL` | No | `https://api.avallon.ai` | Override the API base URL |
|
|
14
|
+
|
|
15
|
+
\*One of `AVALLON_API_KEY` or `AVALLON_ACCESS_TOKEN` is required. Bearer token takes precedence when both are set.
|
|
16
|
+
|
|
17
|
+
### Via npx
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
AVALLON_API_KEY=your-api-key npx @avallon-labs/mcp
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### MCP client configuration
|
|
24
|
+
|
|
25
|
+
Add to your MCP client config (e.g., Claude Desktop `claude_desktop_config.json`):
|
|
26
|
+
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"mcpServers": {
|
|
30
|
+
"avallon": {
|
|
31
|
+
"command": "npx",
|
|
32
|
+
"args": ["@avallon-labs/mcp"],
|
|
33
|
+
"env": {
|
|
34
|
+
"AVALLON_API_KEY": "your-api-key"
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Development
|
|
42
|
+
|
|
43
|
+
### Regenerate from OpenAPI spec
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# From the repo root:
|
|
47
|
+
npm run mcp:gen
|
|
48
|
+
|
|
49
|
+
# Or from packages/mcp (docs must already be generated):
|
|
50
|
+
npm run generate
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Build
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
npm run build
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Test
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
npm run test
|
|
63
|
+
```
|
package/dist/index.d.ts
ADDED