@jullury/shoanta-mcp 0.1.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/LICENSE +21 -0
- package/README.md +102 -0
- package/dist/index.mjs +35701 -0
- package/package.json +49 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Jullury
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# Shoanta MCP Server
|
|
2
|
+
|
|
3
|
+
A **stdio-based MCP (Model Context Protocol) server** that lets any AI agent
|
|
4
|
+
(Claude, opencode, Cursor, Windsurf, etc.) read and update Shoanta tickets
|
|
5
|
+
through the Shoanta REST API (`/api/v1`).
|
|
6
|
+
|
|
7
|
+
The MCP server is a thin proxy: it calls the Shoanta HTTP API using a
|
|
8
|
+
workspace-scoped API token, so all agents share the same auth and data.
|
|
9
|
+
|
|
10
|
+
This folder is **standalone** — copy it into any project (or keep it here) and
|
|
11
|
+
build it there.
|
|
12
|
+
|
|
13
|
+
## Building
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
cd mcp
|
|
17
|
+
pnpm install # or: npm install
|
|
18
|
+
pnpm build # bundles to dist/index.mjs (self-contained, no install needed at runtime)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
The built `dist/index.mjs` inlines all dependencies, so it runs anywhere with
|
|
22
|
+
Node 20+.
|
|
23
|
+
|
|
24
|
+
## Configuration
|
|
25
|
+
|
|
26
|
+
The server needs two environment variables:
|
|
27
|
+
|
|
28
|
+
| Variable | Description |
|
|
29
|
+
| ------------------- | ---------------------------------------------------------- |
|
|
30
|
+
| `SHOANTA_API_URL` | Shoanta base URL, e.g. `https://shoanta.jullury.com` |
|
|
31
|
+
| `SHOANTA_API_TOKEN` | API token created in **Workspace Settings → API tokens** |
|
|
32
|
+
|
|
33
|
+
The token is workspace-scoped, so the server derives the workspace from the
|
|
34
|
+
token itself — you don't need to configure a workspace slug.
|
|
35
|
+
|
|
36
|
+
Create a token in the Shoanta app, add the two values to your environment,
|
|
37
|
+
and run the server:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
SHOANTA_API_URL=https://shoanta.jullury.com \
|
|
41
|
+
SHOANTA_API_TOKEN=shoanta_... \
|
|
42
|
+
node dist/index.mjs
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Tools
|
|
46
|
+
|
|
47
|
+
| Tool | Description |
|
|
48
|
+
| ----------------- | -------------------------------------------------- |
|
|
49
|
+
| `list_databases` | List database boards in the workspace |
|
|
50
|
+
| `list_tickets` | List tickets in a database board |
|
|
51
|
+
| `get_ticket` | Get one ticket by ID (with property values) |
|
|
52
|
+
| `create_ticket` | Create a ticket in a board |
|
|
53
|
+
| `update_ticket` | Update title, content, and/or property values |
|
|
54
|
+
| `delete_ticket` | Delete a ticket (or archive with `archive: true`) |
|
|
55
|
+
| `list_comments` | List comments on a ticket |
|
|
56
|
+
| `add_comment` | Add a comment to a ticket |
|
|
57
|
+
|
|
58
|
+
## Connecting an agent
|
|
59
|
+
|
|
60
|
+
Point your agent's MCP config at the built file with stdio transport.
|
|
61
|
+
|
|
62
|
+
### opencode
|
|
63
|
+
|
|
64
|
+
```jsonc
|
|
65
|
+
// opencode.json
|
|
66
|
+
{
|
|
67
|
+
"mcp": {
|
|
68
|
+
"Shoanta": {
|
|
69
|
+
"type": "local",
|
|
70
|
+
"command": ["node", "/path/to/your/project/mcp/dist/index.mjs"],
|
|
71
|
+
"enabled": true,
|
|
72
|
+
"environment": {
|
|
73
|
+
"SHOANTA_API_URL": "https://shoanta.jullury.com",
|
|
74
|
+
"SHOANTA_API_TOKEN": "shoanta_..."
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Claude Desktop
|
|
82
|
+
|
|
83
|
+
```jsonc
|
|
84
|
+
// claude_desktop_config.json
|
|
85
|
+
{
|
|
86
|
+
"mcpServers": {
|
|
87
|
+
"shoanta": {
|
|
88
|
+
"command": "node",
|
|
89
|
+
"args": ["/path/to/your/project/mcp/dist/index.mjs"],
|
|
90
|
+
"env": {
|
|
91
|
+
"SHOANTA_API_URL": "https://shoanta.jullury.com",
|
|
92
|
+
"SHOANTA_API_TOKEN": "shoanta_..."
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Cursor / Windsurf
|
|
100
|
+
|
|
101
|
+
Add the server with `command: node`, args pointing to `mcp/dist/index.mjs`,
|
|
102
|
+
and the two environment variables set.
|