superops-msp 1.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 +115 -0
- package/docs/api-index.json +12492 -0
- package/docs/introduction.json +9 -0
- package/package.json +41 -0
- package/src/index.mjs +268 -0
package/README.md
ADDED
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# SuperOps MSP MCP Server
|
|
2
|
+
|
|
3
|
+
An MCP (Model Context Protocol) server that provides AI assistants with access to the SuperOps MSP GraphQL API documentation.
|
|
4
|
+
|
|
5
|
+
## What is SuperOps MSP?
|
|
6
|
+
|
|
7
|
+
SuperOps MSP is for **Managed Service Providers** - IT companies that manage technology for multiple client businesses. Key concepts:
|
|
8
|
+
|
|
9
|
+
- **Multi-tenant**: One MSP serves many clients
|
|
10
|
+
- **Client-based**: Data organized by Client → Site → Assets/Tickets
|
|
11
|
+
- **Billing included**: Invoice and billing features for client management
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npx superops-msp
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Or install globally:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install -g superops-msp
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Configuration
|
|
26
|
+
|
|
27
|
+
### Claude Code
|
|
28
|
+
|
|
29
|
+
Add to `~/.claude/settings.json`:
|
|
30
|
+
|
|
31
|
+
```json
|
|
32
|
+
{
|
|
33
|
+
"mcpServers": {
|
|
34
|
+
"superops-msp": {
|
|
35
|
+
"command": "npx",
|
|
36
|
+
"args": ["-y", "superops-msp"]
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Claude Desktop
|
|
43
|
+
|
|
44
|
+
Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS):
|
|
45
|
+
|
|
46
|
+
```json
|
|
47
|
+
{
|
|
48
|
+
"mcpServers": {
|
|
49
|
+
"superops-msp": {
|
|
50
|
+
"command": "npx",
|
|
51
|
+
"args": ["-y", "superops-msp"]
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Available Tools
|
|
58
|
+
|
|
59
|
+
### `search_superops_api`
|
|
60
|
+
|
|
61
|
+
Search the API documentation for queries, mutations, and types.
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
search_superops_api({ query: "ticket" })
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### `get_superops_operation`
|
|
68
|
+
|
|
69
|
+
Get full details of a specific query or mutation.
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
get_superops_operation({ name: "getTicket" })
|
|
73
|
+
get_superops_operation({ name: "createClient" })
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### `get_superops_type`
|
|
77
|
+
|
|
78
|
+
Get full details of a type definition.
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
get_superops_type({ name: "Ticket" })
|
|
82
|
+
get_superops_type({ name: "Client" })
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### `list_superops_operations`
|
|
86
|
+
|
|
87
|
+
List all available operations.
|
|
88
|
+
|
|
89
|
+
```
|
|
90
|
+
list_superops_operations({ type: "queries" })
|
|
91
|
+
list_superops_operations({ type: "mutations" })
|
|
92
|
+
list_superops_operations({ type: "all" })
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## API Endpoints
|
|
96
|
+
|
|
97
|
+
- **US**: `https://api.superops.ai/msp`
|
|
98
|
+
- **EU**: `https://euapi.superops.ai/msp`
|
|
99
|
+
|
|
100
|
+
## Example Usage
|
|
101
|
+
|
|
102
|
+
Once configured, ask Claude:
|
|
103
|
+
|
|
104
|
+
- "How do I create a ticket in SuperOps?"
|
|
105
|
+
- "What fields are available on the Client type?"
|
|
106
|
+
- "Search for invoice-related operations"
|
|
107
|
+
- "Show me how to update an asset"
|
|
108
|
+
|
|
109
|
+
## Related
|
|
110
|
+
|
|
111
|
+
- [superops-it](https://npmjs.com/package/superops-it) - For SuperOps IT Teams (internal IT departments)
|
|
112
|
+
|
|
113
|
+
## License
|
|
114
|
+
|
|
115
|
+
MIT
|