gomami-mcp 0.1.1__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.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 gomami-mcp contributors
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.
@@ -0,0 +1,220 @@
1
+ Metadata-Version: 2.4
2
+ Name: gomami-mcp
3
+ Version: 0.1.1
4
+ Summary: Unofficial MCP server for managing GoMami servers, read-only by default
5
+ License-Expression: MIT
6
+ Project-URL: Homepage, https://github.com/Guoqiang1006/gomami-mcp
7
+ Project-URL: Issues, https://github.com/Guoqiang1006/gomami-mcp/issues
8
+ Project-URL: Changelog, https://github.com/Guoqiang1006/gomami-mcp/releases
9
+ Keywords: mcp,model-context-protocol,gomami,vps
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Environment :: Console
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Intended Audience :: System Administrators
14
+ Classifier: Operating System :: MacOS
15
+ Classifier: Operating System :: POSIX :: Linux
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Programming Language :: Python :: 3.13
21
+ Requires-Python: >=3.10
22
+ Description-Content-Type: text/markdown
23
+ License-File: LICENSE
24
+ Dynamic: license-file
25
+
26
+ # GoMami MCP
27
+
28
+ <!-- mcp-name: io.github.Guoqiang1006/gomami-mcp -->
29
+
30
+ [![Test](https://github.com/Guoqiang1006/gomami-mcp/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/Guoqiang1006/gomami-mcp/actions/workflows/test.yml)
31
+ [![Release](https://img.shields.io/github/v/release/Guoqiang1006/gomami-mcp?include_prereleases)](https://github.com/Guoqiang1006/gomami-mcp/releases)
32
+ [![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue)](https://github.com/Guoqiang1006/gomami-mcp/blob/main/pyproject.toml)
33
+ [![License: MIT](https://img.shields.io/github/license/Guoqiang1006/gomami-mcp)](https://github.com/Guoqiang1006/gomami-mcp/blob/main/LICENSE)
34
+
35
+ [简体中文](https://github.com/Guoqiang1006/gomami-mcp/blob/main/README.zh-CN.md)
36
+
37
+ Manage your GoMami servers from any AI agent that supports the [Model Context Protocol](https://modelcontextprotocol.io), including Claude Code, Codex, Cursor and VS Code.
38
+
39
+ - **Read-only by default.** Changing a server has to be turned on explicitly.
40
+ - **Runs on your computer.** There is nothing to host, and your token goes only to GoMami.
41
+ - **No third-party Python dependencies.** It covers all 29 operations in the GoMami API reference.
42
+
43
+ > **Not affiliated with GoMami.** This is an independent community project.
44
+
45
+ > **Alpha.** `verify_connection`, `get_account` and `list_servers` have been tested against the live API. All other tools, including every tool that changes a server, have only been tested against a local mock. Try them on a disposable server first.
46
+
47
+ ## What you can ask
48
+
49
+ - "List my GoMami servers and show their IP addresses."
50
+ - "When does this server's current traffic period end?"
51
+ - "Show the recent tasks for this server and tell me if any failed."
52
+ - "Which OS templates can I rebuild this server with?"
53
+
54
+ ## Supported agents
55
+
56
+ Any agent that can start a local MCP server over stdio should work.
57
+
58
+ | Agent | Status |
59
+ | --- | --- |
60
+ | Claude Code | Tested with the live API |
61
+ | Official MCP Python SDK | Protocol tested |
62
+ | Codex | Should work, not tested yet |
63
+ | Cursor | Should work, not tested yet |
64
+ | VS Code | Should work, not tested yet |
65
+ | Claude Desktop | Should work, not tested yet |
66
+ | DeepSeek Harness | Should work through its MCP client plugin, not tested yet |
67
+ | Web-only agents that need a remote HTTP server | Not supported |
68
+
69
+ If you try it with another agent, please share the result in [Discussions](https://github.com/Guoqiang1006/gomami-mcp/discussions).
70
+
71
+ ## Quick start
72
+
73
+ You need macOS or Linux, Python 3.10 or newer, [uv](https://docs.astral.sh/uv/) and a GoMami API token.
74
+
75
+ ### 1. Create a token
76
+
77
+ Sign in at `gomami.io` and open [Create API Token](https://gomami.io/createapi.php). The token has full account access and is shown only once.
78
+
79
+ ### 2. Save the token
80
+
81
+ Run this command, paste the token (nothing is displayed), then press Enter:
82
+
83
+ ```bash
84
+ (umask 077; mkdir -p ~/.config/gomami-mcp; IFS= read -rs t; printf '%s\n' "$t" > ~/.config/gomami-mcp/token; unset t)
85
+ ```
86
+
87
+ ### 3. Add the server to your agent
88
+
89
+ Use one of the configurations below, then start a new session.
90
+
91
+ ### 4. Check the connection
92
+
93
+ Ask your agent to run `verify_connection`.
94
+
95
+ ## Agent configuration
96
+
97
+ Desktop apps may not find `uvx` on their `PATH`. If the server fails to start, replace `uvx` with the full path printed by `command -v uvx`.
98
+
99
+ ### Claude Code
100
+
101
+ ```bash
102
+ claude mcp add gomami --scope user -- uvx gomami-mcp@0.1.1
103
+ ```
104
+
105
+ ### Codex
106
+
107
+ Add this to `~/.codex/config.toml`:
108
+
109
+ ```toml
110
+ [mcp_servers.gomami]
111
+ command = "uvx"
112
+ args = ["gomami-mcp@0.1.1"]
113
+ env = { GOMAMI_MCP_ACCESS = "read" }
114
+ startup_timeout_sec = 60
115
+ ```
116
+
117
+ ### Cursor
118
+
119
+ Add this to `~/.cursor/mcp.json`:
120
+
121
+ ```json
122
+ {
123
+ "mcpServers": {
124
+ "gomami": {
125
+ "type": "stdio",
126
+ "command": "uvx",
127
+ "args": ["gomami-mcp@0.1.1"],
128
+ "env": { "GOMAMI_MCP_ACCESS": "read" }
129
+ }
130
+ }
131
+ }
132
+ ```
133
+
134
+ ### VS Code
135
+
136
+ Add this to `.vscode/mcp.json`:
137
+
138
+ ```json
139
+ {
140
+ "servers": {
141
+ "gomami": {
142
+ "type": "stdio",
143
+ "command": "uvx",
144
+ "args": ["gomami-mcp@0.1.1"],
145
+ "env": { "GOMAMI_MCP_ACCESS": "read" }
146
+ }
147
+ }
148
+ }
149
+ ```
150
+
151
+ ### Claude Desktop
152
+
153
+ Add this to `claude_desktop_config.json`:
154
+
155
+ ```json
156
+ {
157
+ "mcpServers": {
158
+ "gomami": {
159
+ "command": "uvx",
160
+ "args": ["gomami-mcp@0.1.1"],
161
+ "env": { "GOMAMI_MCP_ACCESS": "read" }
162
+ }
163
+ }
164
+ }
165
+ ```
166
+
167
+ ### Other agents
168
+
169
+ Configure a local stdio server with this command:
170
+
171
+ ```bash
172
+ uvx gomami-mcp@0.1.1
173
+ ```
174
+
175
+ For DeepSeek Harness, use this command with its `@deepseek-ai/dsh-mcp-client` plugin.
176
+
177
+ ## Settings
178
+
179
+ | Environment variable | Default | Purpose |
180
+ | --- | --- | --- |
181
+ | `GOMAMI_MCP_ACCESS` | `read` | Access tier: `read`, `operate` or `full`. Unknown values fall back to `read`. |
182
+ | `GOMAMI_MCP_PROTECTED_SERVERS` | empty | Comma-separated server IDs that can be read but not changed. |
183
+ | `GOMAMI_API_TOKEN` | empty | Token value. Takes priority over `~/.config/gomami-mcp/token`. |
184
+
185
+ ## Tools
186
+
187
+ | Tier | Tools |
188
+ | --- | --- |
189
+ | `read` | `verify_connection`, `get_account`, `list_ssh_keys`, `list_servers`, `get_server`, `list_os_templates`, `list_swap_options`, `list_isos`, `list_tasks`, `get_task`, `list_resource_packs`, `get_resource_pack` |
190
+ | `operate` | All of the above, plus `get_vnc_status`, `boot_server`, `restart_server`, `shutdown_server`, `power_off_server`, `rename_server` |
191
+ | `full` | All of the above, plus `rebuild_server`, `reset_server_password`, `toggle_rescue`, `toggle_vnc`, `set_iso`, `set_boot_order`, `update_server_settings`, `add_ssh_key`, `delete_ssh_key`, `create_resource_pack_server`, `delete_resource_pack_server` |
192
+
193
+ ## Safety
194
+
195
+ - **Protect production servers.** Add them to `GOMAMI_MCP_PROTECTED_SERVERS`. The MCP server enforces this list in every agent.
196
+ - **Do not rely on approval prompts alone.** Whether an agent asks before running a tool depends on that agent and its settings.
197
+ - **Confirmation text prevents mistakes, not decisions.** Tools that change a server need text such as `REBUILD <server-id>`, but a model can fill it in by itself.
198
+ - **Secrets stay out of the chat.** VNC credentials are hidden, and reset passwords are saved under `~/.config/gomami-mcp/secrets/` with mode `600`.
199
+ - **Write requests are never retried automatically.**
200
+
201
+ See [SECURITY.md](https://github.com/Guoqiang1006/gomami-mcp/blob/main/SECURITY.md) for details and limits.
202
+
203
+ ## Known limitations
204
+
205
+ - Windows is not supported.
206
+ - The API reference does not say what value `set_iso` needs to eject an ISO.
207
+ - The API reference describes `GET /server/{id}/vnc` as a toggle, which looks like a typo. It is placed in the `operate` tier to be safe.
208
+ - The API is behind Cloudflare. Blocked requests are reported clearly, and this project does not try to work around them.
209
+
210
+ ## Development
211
+
212
+ ```bash
213
+ python3 -m unittest discover -s tests -v
214
+ ```
215
+
216
+ Tests use a local mock and never contact GoMami.
217
+
218
+ ## License
219
+
220
+ [MIT](https://github.com/Guoqiang1006/gomami-mcp/blob/main/LICENSE)
@@ -0,0 +1,195 @@
1
+ # GoMami MCP
2
+
3
+ <!-- mcp-name: io.github.Guoqiang1006/gomami-mcp -->
4
+
5
+ [![Test](https://github.com/Guoqiang1006/gomami-mcp/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/Guoqiang1006/gomami-mcp/actions/workflows/test.yml)
6
+ [![Release](https://img.shields.io/github/v/release/Guoqiang1006/gomami-mcp?include_prereleases)](https://github.com/Guoqiang1006/gomami-mcp/releases)
7
+ [![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue)](https://github.com/Guoqiang1006/gomami-mcp/blob/main/pyproject.toml)
8
+ [![License: MIT](https://img.shields.io/github/license/Guoqiang1006/gomami-mcp)](https://github.com/Guoqiang1006/gomami-mcp/blob/main/LICENSE)
9
+
10
+ [简体中文](https://github.com/Guoqiang1006/gomami-mcp/blob/main/README.zh-CN.md)
11
+
12
+ Manage your GoMami servers from any AI agent that supports the [Model Context Protocol](https://modelcontextprotocol.io), including Claude Code, Codex, Cursor and VS Code.
13
+
14
+ - **Read-only by default.** Changing a server has to be turned on explicitly.
15
+ - **Runs on your computer.** There is nothing to host, and your token goes only to GoMami.
16
+ - **No third-party Python dependencies.** It covers all 29 operations in the GoMami API reference.
17
+
18
+ > **Not affiliated with GoMami.** This is an independent community project.
19
+
20
+ > **Alpha.** `verify_connection`, `get_account` and `list_servers` have been tested against the live API. All other tools, including every tool that changes a server, have only been tested against a local mock. Try them on a disposable server first.
21
+
22
+ ## What you can ask
23
+
24
+ - "List my GoMami servers and show their IP addresses."
25
+ - "When does this server's current traffic period end?"
26
+ - "Show the recent tasks for this server and tell me if any failed."
27
+ - "Which OS templates can I rebuild this server with?"
28
+
29
+ ## Supported agents
30
+
31
+ Any agent that can start a local MCP server over stdio should work.
32
+
33
+ | Agent | Status |
34
+ | --- | --- |
35
+ | Claude Code | Tested with the live API |
36
+ | Official MCP Python SDK | Protocol tested |
37
+ | Codex | Should work, not tested yet |
38
+ | Cursor | Should work, not tested yet |
39
+ | VS Code | Should work, not tested yet |
40
+ | Claude Desktop | Should work, not tested yet |
41
+ | DeepSeek Harness | Should work through its MCP client plugin, not tested yet |
42
+ | Web-only agents that need a remote HTTP server | Not supported |
43
+
44
+ If you try it with another agent, please share the result in [Discussions](https://github.com/Guoqiang1006/gomami-mcp/discussions).
45
+
46
+ ## Quick start
47
+
48
+ You need macOS or Linux, Python 3.10 or newer, [uv](https://docs.astral.sh/uv/) and a GoMami API token.
49
+
50
+ ### 1. Create a token
51
+
52
+ Sign in at `gomami.io` and open [Create API Token](https://gomami.io/createapi.php). The token has full account access and is shown only once.
53
+
54
+ ### 2. Save the token
55
+
56
+ Run this command, paste the token (nothing is displayed), then press Enter:
57
+
58
+ ```bash
59
+ (umask 077; mkdir -p ~/.config/gomami-mcp; IFS= read -rs t; printf '%s\n' "$t" > ~/.config/gomami-mcp/token; unset t)
60
+ ```
61
+
62
+ ### 3. Add the server to your agent
63
+
64
+ Use one of the configurations below, then start a new session.
65
+
66
+ ### 4. Check the connection
67
+
68
+ Ask your agent to run `verify_connection`.
69
+
70
+ ## Agent configuration
71
+
72
+ Desktop apps may not find `uvx` on their `PATH`. If the server fails to start, replace `uvx` with the full path printed by `command -v uvx`.
73
+
74
+ ### Claude Code
75
+
76
+ ```bash
77
+ claude mcp add gomami --scope user -- uvx gomami-mcp@0.1.1
78
+ ```
79
+
80
+ ### Codex
81
+
82
+ Add this to `~/.codex/config.toml`:
83
+
84
+ ```toml
85
+ [mcp_servers.gomami]
86
+ command = "uvx"
87
+ args = ["gomami-mcp@0.1.1"]
88
+ env = { GOMAMI_MCP_ACCESS = "read" }
89
+ startup_timeout_sec = 60
90
+ ```
91
+
92
+ ### Cursor
93
+
94
+ Add this to `~/.cursor/mcp.json`:
95
+
96
+ ```json
97
+ {
98
+ "mcpServers": {
99
+ "gomami": {
100
+ "type": "stdio",
101
+ "command": "uvx",
102
+ "args": ["gomami-mcp@0.1.1"],
103
+ "env": { "GOMAMI_MCP_ACCESS": "read" }
104
+ }
105
+ }
106
+ }
107
+ ```
108
+
109
+ ### VS Code
110
+
111
+ Add this to `.vscode/mcp.json`:
112
+
113
+ ```json
114
+ {
115
+ "servers": {
116
+ "gomami": {
117
+ "type": "stdio",
118
+ "command": "uvx",
119
+ "args": ["gomami-mcp@0.1.1"],
120
+ "env": { "GOMAMI_MCP_ACCESS": "read" }
121
+ }
122
+ }
123
+ }
124
+ ```
125
+
126
+ ### Claude Desktop
127
+
128
+ Add this to `claude_desktop_config.json`:
129
+
130
+ ```json
131
+ {
132
+ "mcpServers": {
133
+ "gomami": {
134
+ "command": "uvx",
135
+ "args": ["gomami-mcp@0.1.1"],
136
+ "env": { "GOMAMI_MCP_ACCESS": "read" }
137
+ }
138
+ }
139
+ }
140
+ ```
141
+
142
+ ### Other agents
143
+
144
+ Configure a local stdio server with this command:
145
+
146
+ ```bash
147
+ uvx gomami-mcp@0.1.1
148
+ ```
149
+
150
+ For DeepSeek Harness, use this command with its `@deepseek-ai/dsh-mcp-client` plugin.
151
+
152
+ ## Settings
153
+
154
+ | Environment variable | Default | Purpose |
155
+ | --- | --- | --- |
156
+ | `GOMAMI_MCP_ACCESS` | `read` | Access tier: `read`, `operate` or `full`. Unknown values fall back to `read`. |
157
+ | `GOMAMI_MCP_PROTECTED_SERVERS` | empty | Comma-separated server IDs that can be read but not changed. |
158
+ | `GOMAMI_API_TOKEN` | empty | Token value. Takes priority over `~/.config/gomami-mcp/token`. |
159
+
160
+ ## Tools
161
+
162
+ | Tier | Tools |
163
+ | --- | --- |
164
+ | `read` | `verify_connection`, `get_account`, `list_ssh_keys`, `list_servers`, `get_server`, `list_os_templates`, `list_swap_options`, `list_isos`, `list_tasks`, `get_task`, `list_resource_packs`, `get_resource_pack` |
165
+ | `operate` | All of the above, plus `get_vnc_status`, `boot_server`, `restart_server`, `shutdown_server`, `power_off_server`, `rename_server` |
166
+ | `full` | All of the above, plus `rebuild_server`, `reset_server_password`, `toggle_rescue`, `toggle_vnc`, `set_iso`, `set_boot_order`, `update_server_settings`, `add_ssh_key`, `delete_ssh_key`, `create_resource_pack_server`, `delete_resource_pack_server` |
167
+
168
+ ## Safety
169
+
170
+ - **Protect production servers.** Add them to `GOMAMI_MCP_PROTECTED_SERVERS`. The MCP server enforces this list in every agent.
171
+ - **Do not rely on approval prompts alone.** Whether an agent asks before running a tool depends on that agent and its settings.
172
+ - **Confirmation text prevents mistakes, not decisions.** Tools that change a server need text such as `REBUILD <server-id>`, but a model can fill it in by itself.
173
+ - **Secrets stay out of the chat.** VNC credentials are hidden, and reset passwords are saved under `~/.config/gomami-mcp/secrets/` with mode `600`.
174
+ - **Write requests are never retried automatically.**
175
+
176
+ See [SECURITY.md](https://github.com/Guoqiang1006/gomami-mcp/blob/main/SECURITY.md) for details and limits.
177
+
178
+ ## Known limitations
179
+
180
+ - Windows is not supported.
181
+ - The API reference does not say what value `set_iso` needs to eject an ISO.
182
+ - The API reference describes `GET /server/{id}/vnc` as a toggle, which looks like a typo. It is placed in the `operate` tier to be safe.
183
+ - The API is behind Cloudflare. Blocked requests are reported clearly, and this project does not try to work around them.
184
+
185
+ ## Development
186
+
187
+ ```bash
188
+ python3 -m unittest discover -s tests -v
189
+ ```
190
+
191
+ Tests use a local mock and never contact GoMami.
192
+
193
+ ## License
194
+
195
+ [MIT](https://github.com/Guoqiang1006/gomami-mcp/blob/main/LICENSE)
@@ -0,0 +1,42 @@
1
+ [build-system]
2
+ requires = ["setuptools>=77"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "gomami-mcp"
7
+ dynamic = ["version"]
8
+ description = "Unofficial MCP server for managing GoMami servers, read-only by default"
9
+ readme = "README.md"
10
+ requires-python = ">=3.10"
11
+ license = "MIT"
12
+ license-files = ["LICENSE"]
13
+ keywords = ["mcp", "model-context-protocol", "gomami", "vps"]
14
+ classifiers = [
15
+ "Development Status :: 3 - Alpha",
16
+ "Environment :: Console",
17
+ "Intended Audience :: Developers",
18
+ "Intended Audience :: System Administrators",
19
+ "Operating System :: MacOS",
20
+ "Operating System :: POSIX :: Linux",
21
+ "Programming Language :: Python :: 3",
22
+ "Programming Language :: Python :: 3.10",
23
+ "Programming Language :: Python :: 3.11",
24
+ "Programming Language :: Python :: 3.12",
25
+ "Programming Language :: Python :: 3.13",
26
+ ]
27
+ dependencies = []
28
+
29
+ [project.urls]
30
+ Homepage = "https://github.com/Guoqiang1006/gomami-mcp"
31
+ Issues = "https://github.com/Guoqiang1006/gomami-mcp/issues"
32
+ Changelog = "https://github.com/Guoqiang1006/gomami-mcp/releases"
33
+
34
+ [project.scripts]
35
+ gomami-mcp = "gomami_mcp:main"
36
+
37
+ [tool.setuptools]
38
+ package-dir = { "" = "src" }
39
+ py-modules = ["gomami_mcp"]
40
+
41
+ [tool.setuptools.dynamic]
42
+ version = { attr = "gomami_mcp.__version__" }
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+