@sproobo/mcp 0.1.2 → 0.1.3

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.
Files changed (2) hide show
  1. package/README.md +129 -0
  2. package/package.json +3 -2
package/README.md ADDED
@@ -0,0 +1,129 @@
1
+ # @sproobo/mcp
2
+
3
+ [Model Context Protocol](https://modelcontextprotocol.io/) server for [Sproobo](https://sproobo.com) — deploy sites, manage servers, and configure infrastructure from AI agents like Claude Desktop, Cursor, Windsurf, and any MCP-compatible client.
4
+
5
+ ## Quick start
6
+
7
+ ### Claude Desktop
8
+
9
+ Add to your Claude Desktop config (`~/Library/Application Support/Claude/claude_desktop_config.json`):
10
+
11
+ ```json
12
+ {
13
+ "mcpServers": {
14
+ "sproobo": {
15
+ "command": "npx",
16
+ "args": ["-y", "@sproobo/mcp"],
17
+ "env": {
18
+ "SPROOBO_API_KEY": "spb_your_key_here"
19
+ }
20
+ }
21
+ }
22
+ }
23
+ ```
24
+
25
+ ### Cursor
26
+
27
+ Add to `.cursor/mcp.json` in your project:
28
+
29
+ ```json
30
+ {
31
+ "mcpServers": {
32
+ "sproobo": {
33
+ "command": "npx",
34
+ "args": ["-y", "@sproobo/mcp"],
35
+ "env": {
36
+ "SPROOBO_API_KEY": "spb_your_key_here"
37
+ }
38
+ }
39
+ }
40
+ }
41
+ ```
42
+
43
+ ### Claude Code
44
+
45
+ ```bash
46
+ claude mcp add sproobo -- npx -y @sproobo/mcp
47
+ ```
48
+
49
+ Then set your API key in the environment:
50
+
51
+ ```bash
52
+ export SPROOBO_API_KEY="spb_your_key_here"
53
+ ```
54
+
55
+ ## Authentication
56
+
57
+ Create an API key in the Sproobo dashboard under **Settings > API Keys**. See the [API Keys docs](https://sproobo.com/docs/api-keys) for details.
58
+
59
+ | Variable | Required | Description |
60
+ | --- | --- | --- |
61
+ | `SPROOBO_API_KEY` | Yes | Your API key (e.g. `spb_...`) |
62
+ | `SPROOBO_API_URL` | No | Custom API base URL (defaults to `https://dashboard.sproobo.com`) |
63
+
64
+ > **Never** commit API keys to source control or shared config files. Use your client's secret store or environment variables.
65
+
66
+ ## Available tools
67
+
68
+ ### Servers
69
+
70
+ | Tool | Description |
71
+ | --- | --- |
72
+ | `list_servers` | List all servers with status, IP, and provider info |
73
+ | `get_server` | Get detailed info about a specific server |
74
+ | `get_server_metrics` | Get latest CPU, memory, disk, and network metrics |
75
+
76
+ ### Sites
77
+
78
+ | Tool | Description |
79
+ | --- | --- |
80
+ | `list_sites` | List all sites deployed on a server |
81
+ | `get_site` | Get site details including domains and deployment type |
82
+
83
+ ### Deployments
84
+
85
+ | Tool | Description |
86
+ | --- | --- |
87
+ | `deploy_site` | Trigger a new deployment, optionally for a specific commit |
88
+ | `list_deployments` | List deployment history, most recent first |
89
+ | `get_deployment` | Get deployment details including status and timing |
90
+ | `get_deployment_logs` | Stream build and deploy logs for a deployment |
91
+ | `rollback_site` | Rollback to a previous deployment (fast or safe mode) |
92
+
93
+ ### Services
94
+
95
+ | Tool | Description |
96
+ | --- | --- |
97
+ | `list_services` | List installed services (Redis, PostgreSQL, etc.) |
98
+
99
+ ### Nginx
100
+
101
+ | Tool | Description |
102
+ | --- | --- |
103
+ | `list_nginx_templates` | List available nginx configuration templates |
104
+ | `get_nginx_config_files` | Get nginx config files on a server |
105
+ | `test_nginx_config` | Test nginx configuration for syntax errors |
106
+ | `apply_nginx_template` | Apply an nginx template to a site |
107
+
108
+ ### Firewall
109
+
110
+ | Tool | Description |
111
+ | --- | --- |
112
+ | `list_firewall_rules` | List all firewall rules on a server |
113
+ | `create_firewall_rule` | Create a new firewall rule |
114
+ | `delete_firewall_rule` | Delete a firewall rule |
115
+ | `apply_firewall_rules` | Apply configured rules to the server |
116
+
117
+ ## Security
118
+
119
+ - Sensitive fields (env vars, passwords, tokens, keys, credentials) are automatically redacted from all API responses
120
+ - API keys are transmitted as Bearer tokens over HTTPS
121
+ - The server never stores credentials — it reads `SPROOBO_API_KEY` from the environment at startup
122
+
123
+ ## Documentation
124
+
125
+ Full documentation is available at [sproobo.com/docs/mcp](https://sproobo.com/docs/mcp).
126
+
127
+ ## License
128
+
129
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sproobo/mcp",
3
- "version": "0.1.2",
3
+ "version": "0.1.3",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "description": "Sproobo MCP server — deploy sites, manage servers, and configure infrastructure from AI agents",
@@ -16,7 +16,8 @@
16
16
  }
17
17
  },
18
18
  "files": [
19
- "dist"
19
+ "dist",
20
+ "README.md"
20
21
  ],
21
22
  "dependencies": {
22
23
  "@modelcontextprotocol/sdk": "^1.12.1",