deploy-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/CHANGELOG.md +45 -0
- package/LICENSE +55 -0
- package/README.md +499 -0
- package/SECURITY.md +61 -0
- package/dist/chunk-QRZL43CY.js +297 -0
- package/dist/index.js +95 -0
- package/dist/worker.js +1212 -0
- package/package.json +80 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
## [0.1.0] - 2025-01-15
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- Initial release of deploy-mcp
|
|
15
|
+
- MCP server for deployment status tracking
|
|
16
|
+
- Vercel adapter with full API integration
|
|
17
|
+
- Professional landing page with AI tools configuration
|
|
18
|
+
- Support for multiple AI assistants:
|
|
19
|
+
- Claude Desktop (official support)
|
|
20
|
+
- VS Code with GitHub Copilot
|
|
21
|
+
- Cursor AI
|
|
22
|
+
- Windsurf IDE
|
|
23
|
+
- Continue.dev
|
|
24
|
+
- Cline
|
|
25
|
+
- Comprehensive configuration examples and documentation
|
|
26
|
+
- TypeScript with strict mode
|
|
27
|
+
- ESLint + Prettier with automated formatting
|
|
28
|
+
- Vitest testing framework
|
|
29
|
+
- Husky pre-commit hooks
|
|
30
|
+
- Cloudflare Workers deployment
|
|
31
|
+
- Feature-based adapter architecture
|
|
32
|
+
- Professional package.json scripts
|
|
33
|
+
- Security policy and community guidelines
|
|
34
|
+
|
|
35
|
+
### Technical Details
|
|
36
|
+
|
|
37
|
+
- Node.js 22+ requirement
|
|
38
|
+
- Updated MCP SDK to 1.11.2
|
|
39
|
+
- Zero runtime dependencies for core functionality
|
|
40
|
+
- Strict TypeScript compilation
|
|
41
|
+
- Automated code quality checks
|
|
42
|
+
- Professional open source project structure
|
|
43
|
+
|
|
44
|
+
[Unreleased]: https://github.com/alexpota/deploy-mcp/compare/v0.1.0...HEAD
|
|
45
|
+
[0.1.0]: https://github.com/alexpota/deploy-mcp/releases/tag/v0.1.0
|
package/LICENSE
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
|
|
10
|
+
|
|
11
|
+
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
|
|
12
|
+
|
|
13
|
+
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
|
|
14
|
+
|
|
15
|
+
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
|
|
16
|
+
|
|
17
|
+
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
|
|
18
|
+
|
|
19
|
+
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
|
|
20
|
+
|
|
21
|
+
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
|
|
22
|
+
|
|
23
|
+
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
|
|
24
|
+
|
|
25
|
+
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
|
|
26
|
+
|
|
27
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
|
|
28
|
+
|
|
29
|
+
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
|
|
30
|
+
|
|
31
|
+
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
|
|
32
|
+
|
|
33
|
+
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
|
|
34
|
+
|
|
35
|
+
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
|
|
36
|
+
|
|
37
|
+
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
|
|
38
|
+
|
|
39
|
+
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
|
|
40
|
+
|
|
41
|
+
(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
|
|
42
|
+
|
|
43
|
+
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
|
|
44
|
+
|
|
45
|
+
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
|
|
46
|
+
|
|
47
|
+
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
|
|
48
|
+
|
|
49
|
+
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
|
|
50
|
+
|
|
51
|
+
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
|
|
52
|
+
|
|
53
|
+
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
|
|
54
|
+
|
|
55
|
+
END OF TERMS AND CONDITIONS
|
package/README.md
ADDED
|
@@ -0,0 +1,499 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# deploy-mcp
|
|
4
|
+
|
|
5
|
+
**Universal Deployment Tracker for AI Assistants**
|
|
6
|
+
|
|
7
|
+
Track deployments across all platforms directly in your AI conversation.
|
|
8
|
+
No more context-switching. No more dashboard hunting.
|
|
9
|
+
|
|
10
|
+
[](https://www.npmjs.com/package/deploy-mcp)
|
|
11
|
+
[](https://github.com/alexpota/deploy-mcp/blob/main/LICENSE)
|
|
12
|
+
[](https://deploy-mcp.io)
|
|
13
|
+
|
|
14
|
+
</div>
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Demo
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
// In your AI conversation:
|
|
22
|
+
"Check my latest Vercel deployment"
|
|
23
|
+
|
|
24
|
+
// Claude's Response:
|
|
25
|
+
✅ **Status**: Success
|
|
26
|
+
🌐 **Live URL**: https://my-app.vercel.app
|
|
27
|
+
⏱️ **Deployment Time**: 45 seconds
|
|
28
|
+
📅 **Last Deployed**: January 15, 2025 at 10:30 UTC
|
|
29
|
+
🌍 **Environment**: Production
|
|
30
|
+
|
|
31
|
+
**Latest Commit**:
|
|
32
|
+
- SHA: `abc123ef`
|
|
33
|
+
- Message: "Update homepage hero section"
|
|
34
|
+
- Author: John Doe
|
|
35
|
+
|
|
36
|
+
Everything looks good - your deployment is live and running successfully!
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
**Just ask your AI**: *"What's the status of my latest deployment?"*
|
|
40
|
+
Get instant answers without leaving your conversation.
|
|
41
|
+
|
|
42
|
+
## Features
|
|
43
|
+
|
|
44
|
+
<table>
|
|
45
|
+
<tr>
|
|
46
|
+
<td width="50%">
|
|
47
|
+
|
|
48
|
+
**Universal AI Support**
|
|
49
|
+
Built for the Model Context Protocol. Works seamlessly with Claude Desktop, VS Code, Cursor, Windsurf, Continue.dev, Cline, and any MCP-compatible AI assistant.
|
|
50
|
+
|
|
51
|
+
**Secure & Private**
|
|
52
|
+
Your API tokens stay local on your machine. Never sent to third parties or logged anywhere.
|
|
53
|
+
|
|
54
|
+
**Lightning Fast**
|
|
55
|
+
Get deployment status in under 2 seconds. Optimized for developer productivity.
|
|
56
|
+
|
|
57
|
+
</td>
|
|
58
|
+
<td width="50%">
|
|
59
|
+
|
|
60
|
+
**Zero Context Switching**
|
|
61
|
+
Check deployment status without leaving your AI conversation.
|
|
62
|
+
|
|
63
|
+
**Universal Platform Support**
|
|
64
|
+
Currently supports Vercel, with Netlify, Railway, and Render coming soon.
|
|
65
|
+
|
|
66
|
+
**Real-time Status**
|
|
67
|
+
Get instant deployment status through AI conversation.
|
|
68
|
+
|
|
69
|
+
**Open Source**
|
|
70
|
+
Fully transparent, community-driven development.
|
|
71
|
+
|
|
72
|
+
</td>
|
|
73
|
+
</tr>
|
|
74
|
+
</table>
|
|
75
|
+
|
|
76
|
+
## Why deploy-mcp?
|
|
77
|
+
|
|
78
|
+
**The Problem**: Developers context-switch 10-20 times per day to check deployment status, losing 23 minutes of focus each time.
|
|
79
|
+
|
|
80
|
+
**The Solution**: deploy-mcp brings deployment status directly into your AI conversation. No more alt-tabbing, no more dashboard hunting, no more broken flow state.
|
|
81
|
+
|
|
82
|
+
Built for the modern developer who uses AI assistants as part of their daily workflow.
|
|
83
|
+
|
|
84
|
+
## Quick Start
|
|
85
|
+
|
|
86
|
+
**Get started in under 30 seconds:**
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
npx deploy-mcp
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
That's it! The server is now running and ready to be configured in your AI assistant.
|
|
93
|
+
|
|
94
|
+
## Configuration
|
|
95
|
+
|
|
96
|
+
### AI Assistants
|
|
97
|
+
|
|
98
|
+
<details>
|
|
99
|
+
<summary><strong>Claude Desktop</strong> ✅</summary>
|
|
100
|
+
|
|
101
|
+
**Official MCP support** - Ready to use today
|
|
102
|
+
|
|
103
|
+
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
104
|
+
**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
105
|
+
**Linux**: `~/.config/Claude/claude_desktop_config.json`
|
|
106
|
+
|
|
107
|
+
</details>
|
|
108
|
+
|
|
109
|
+
<details>
|
|
110
|
+
<summary><strong>VS Code</strong> ✅</summary>
|
|
111
|
+
|
|
112
|
+
**Official MCP support** - Generally available in VS Code 1.102+
|
|
113
|
+
|
|
114
|
+
Add to workspace `.vscode/mcp.json` or global `~/.vscode/mcp.json`
|
|
115
|
+
|
|
116
|
+
Requires GitHub Copilot subscription and MCP policy enabled by organization.
|
|
117
|
+
</details>
|
|
118
|
+
|
|
119
|
+
<details>
|
|
120
|
+
<summary><strong>Cursor AI</strong> ✅</summary>
|
|
121
|
+
|
|
122
|
+
**Official MCP support** - Available with one-click installation
|
|
123
|
+
|
|
124
|
+
Navigate to Cursor Settings → MCP or create `~/.cursor/mcp.json`
|
|
125
|
+
|
|
126
|
+
</details>
|
|
127
|
+
|
|
128
|
+
<details>
|
|
129
|
+
<summary><strong>Windsurf IDE</strong> ✅</summary>
|
|
130
|
+
|
|
131
|
+
**Official MCP support** - Native integration with Cascade
|
|
132
|
+
|
|
133
|
+
Navigate to Windsurf Settings → Advanced Settings → Cascade or edit `~/.codeium/windsurf/mcp_config.json`
|
|
134
|
+
|
|
135
|
+
</details>
|
|
136
|
+
|
|
137
|
+
<details>
|
|
138
|
+
<summary><strong>Continue.dev</strong> ✅</summary>
|
|
139
|
+
|
|
140
|
+
**Official MCP support** - Available in agent mode
|
|
141
|
+
|
|
142
|
+
Add to your `config.json` with different structure:
|
|
143
|
+
|
|
144
|
+
```json
|
|
145
|
+
{
|
|
146
|
+
"experimental": {
|
|
147
|
+
"modelContextProtocolServer": {
|
|
148
|
+
"transport": {
|
|
149
|
+
"type": "stdio",
|
|
150
|
+
"command": "npx",
|
|
151
|
+
"args": ["-y", "deploy-mcp"]
|
|
152
|
+
},
|
|
153
|
+
"env": {
|
|
154
|
+
"VERCEL_TOKEN": "your-vercel-token"
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
Or create `.continue/mcpServers/` folder in your workspace.
|
|
162
|
+
</details>
|
|
163
|
+
|
|
164
|
+
<details>
|
|
165
|
+
<summary><strong>Cline (VS Code)</strong> ✅</summary>
|
|
166
|
+
|
|
167
|
+
**Official MCP support** - Can create and install tools automatically
|
|
168
|
+
|
|
169
|
+
Cline can install deploy-mcp through natural language:
|
|
170
|
+
- Ask: *"Add the deploy-mcp tool to check Vercel deployments"*
|
|
171
|
+
- Or manually configure via MCP Servers icon → Advanced MCP Settings
|
|
172
|
+
|
|
173
|
+
</details>
|
|
174
|
+
|
|
175
|
+
**+ Any MCP-compatible tool**
|
|
176
|
+
Works with all AI assistants that support [Model Context Protocol](https://modelcontextprotocol.io)
|
|
177
|
+
|
|
178
|
+
### MCP Configuration
|
|
179
|
+
|
|
180
|
+
All AI tools (except Continue.dev) use the same configuration:
|
|
181
|
+
|
|
182
|
+
```json
|
|
183
|
+
{
|
|
184
|
+
"mcpServers": {
|
|
185
|
+
"deploy-mcp": {
|
|
186
|
+
"command": "npx",
|
|
187
|
+
"args": ["-y", "deploy-mcp"],
|
|
188
|
+
"env": {
|
|
189
|
+
"VERCEL_TOKEN": "your-vercel-token"
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
💡 Replace `your-vercel-token` with your actual Vercel API token from [vercel.com/account/tokens](https://vercel.com/account/tokens)
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
### Getting API Tokens
|
|
200
|
+
|
|
201
|
+
<details>
|
|
202
|
+
<summary><strong>Vercel</strong></summary>
|
|
203
|
+
|
|
204
|
+
1. Go to [Vercel Dashboard](https://vercel.com/account/tokens)
|
|
205
|
+
2. Click **"Create Token"**
|
|
206
|
+
3. Give it a descriptive name (e.g., "deploy-mcp")
|
|
207
|
+
4. Select appropriate scope (read-only is sufficient)
|
|
208
|
+
5. Copy the token and add it to your configuration
|
|
209
|
+
|
|
210
|
+
</details>
|
|
211
|
+
|
|
212
|
+
<details>
|
|
213
|
+
<summary><strong>Netlify</strong> (Coming Soon)</summary>
|
|
214
|
+
|
|
215
|
+
1. Go to [Netlify User Settings](https://app.netlify.com/user/applications#personal-access-tokens)
|
|
216
|
+
2. Click **"New access token"**
|
|
217
|
+
3. Give it a descriptive name
|
|
218
|
+
4. Copy the token
|
|
219
|
+
</details>
|
|
220
|
+
|
|
221
|
+
<details>
|
|
222
|
+
<summary><strong>Railway</strong> (Coming Soon)</summary>
|
|
223
|
+
|
|
224
|
+
Railway integration is on our roadmap. [Star the repo](https://github.com/alexpota/deploy-mcp) to get notified!
|
|
225
|
+
</details>
|
|
226
|
+
|
|
227
|
+
<details>
|
|
228
|
+
<summary><strong>Render</strong> (Coming Soon)</summary>
|
|
229
|
+
|
|
230
|
+
Render integration is on our roadmap. [Star the repo](https://github.com/alexpota/deploy-mcp) to get notified!
|
|
231
|
+
</details>
|
|
232
|
+
|
|
233
|
+
## Usage Examples
|
|
234
|
+
|
|
235
|
+
### In Your AI Conversation
|
|
236
|
+
|
|
237
|
+
Once configured, simply ask your AI assistant:
|
|
238
|
+
|
|
239
|
+
```
|
|
240
|
+
You: Check my latest Vercel deployment
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
Assistant: I'll check your latest Vercel deployment for you.
|
|
244
|
+
|
|
245
|
+
✅ **Status**: Success
|
|
246
|
+
🌐 **Live URL**: https://my-app.vercel.app
|
|
247
|
+
⏱️ **Deployment Time**: 45 seconds
|
|
248
|
+
📅 **Last Deployed**: January 15, 2025 at 10:30 UTC
|
|
249
|
+
🌍 **Environment**: Production
|
|
250
|
+
|
|
251
|
+
**Latest Commit**:
|
|
252
|
+
- SHA: `abc123ef`
|
|
253
|
+
- Message: "Update homepage hero section"
|
|
254
|
+
- Author: John Doe
|
|
255
|
+
|
|
256
|
+
Everything looks good - your deployment is live and running successfully!
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
### More Examples
|
|
260
|
+
|
|
261
|
+
- `"Is my website deployment finished?"`
|
|
262
|
+
- `"Show me the deployment status for project-xyz"`
|
|
263
|
+
- `"Check if the production deployment succeeded"`
|
|
264
|
+
- `"What's the status of my latest deploy?"`
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
## MCP Tools Reference
|
|
268
|
+
Retrieve the latest deployment status for a project.
|
|
269
|
+
|
|
270
|
+
<details>
|
|
271
|
+
<summary><strong>Parameters</strong></summary>
|
|
272
|
+
|
|
273
|
+
| Parameter | Type | Required | Description |
|
|
274
|
+
|-----------|------|----------|-------------|
|
|
275
|
+
| `platform` | string | ✓ | Deployment platform (`vercel`, `netlify`, etc.) |
|
|
276
|
+
| `project` | string | ✓ | Project name or ID |
|
|
277
|
+
| `token` | string | ✗ | API token (uses env variable if not provided) |
|
|
278
|
+
|
|
279
|
+
</details>
|
|
280
|
+
|
|
281
|
+
<details>
|
|
282
|
+
<summary><strong>Response Format</strong></summary>
|
|
283
|
+
|
|
284
|
+
```typescript
|
|
285
|
+
{
|
|
286
|
+
status: "success" | "failed" | "building" | "error",
|
|
287
|
+
url: string,
|
|
288
|
+
projectName: string,
|
|
289
|
+
platform: string,
|
|
290
|
+
timestamp: string,
|
|
291
|
+
duration: number,
|
|
292
|
+
environment: "production" | "preview" | "development",
|
|
293
|
+
commit: {
|
|
294
|
+
sha: string,
|
|
295
|
+
message: string,
|
|
296
|
+
author: string
|
|
297
|
+
}
|
|
298
|
+
}
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
</details>
|
|
302
|
+
|
|
303
|
+
## Development
|
|
304
|
+
|
|
305
|
+
For contributors who want to help develop deploy-mcp.
|
|
306
|
+
|
|
307
|
+
### Prerequisites
|
|
308
|
+
|
|
309
|
+
- Node.js 22 or higher
|
|
310
|
+
- npm, yarn, or pnpm
|
|
311
|
+
|
|
312
|
+
### Local Development
|
|
313
|
+
|
|
314
|
+
```bash
|
|
315
|
+
# Clone the repository
|
|
316
|
+
git clone https://github.com/alexpota/deploy-mcp.git
|
|
317
|
+
cd deploy-mcp
|
|
318
|
+
|
|
319
|
+
# Install dependencies
|
|
320
|
+
npm install
|
|
321
|
+
|
|
322
|
+
# Run in development mode
|
|
323
|
+
npm run dev
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
### Testing
|
|
327
|
+
|
|
328
|
+
```bash
|
|
329
|
+
# Run tests
|
|
330
|
+
npm test
|
|
331
|
+
|
|
332
|
+
# Type checking
|
|
333
|
+
npm run lint
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
### Building & Deployment
|
|
337
|
+
|
|
338
|
+
```bash
|
|
339
|
+
# Build TypeScript
|
|
340
|
+
npm run build
|
|
341
|
+
|
|
342
|
+
# Deploy worker to Cloudflare
|
|
343
|
+
npm run deploy
|
|
344
|
+
|
|
345
|
+
# Development worker server
|
|
346
|
+
npm run dev:worker
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
## Project Structure
|
|
350
|
+
|
|
351
|
+
```
|
|
352
|
+
deploy-mcp/
|
|
353
|
+
├── src/
|
|
354
|
+
│ ├── index.ts # MCP server entry point
|
|
355
|
+
│ ├── worker.ts # Cloudflare Worker for website
|
|
356
|
+
│ ├── adapters/ # Platform adapters (new structure)
|
|
357
|
+
│ │ ├── base/ # Base adapter framework
|
|
358
|
+
│ │ │ ├── adapter.ts # Abstract base class
|
|
359
|
+
│ │ │ ├── types.ts # Common interfaces
|
|
360
|
+
│ │ │ └── index.ts # Base exports
|
|
361
|
+
│ │ ├── vercel/ # Vercel platform support
|
|
362
|
+
│ │ │ ├── index.ts # Main adapter class
|
|
363
|
+
│ │ │ ├── types.ts # Vercel-specific types
|
|
364
|
+
│ │ │ ├── api.ts # API client
|
|
365
|
+
│ │ │ └── __tests__/ # Vercel tests
|
|
366
|
+
│ │ └── index.ts # All adapter exports
|
|
367
|
+
│ ├── core/
|
|
368
|
+
│ │ ├── mcp-handler.ts # MCP protocol implementation
|
|
369
|
+
│ │ └── tools.ts # MCP tool definitions
|
|
370
|
+
│ ├── server/
|
|
371
|
+
│ │ └── badge.ts # SVG badge generation (v0.2.0)
|
|
372
|
+
│ └── types.ts # TypeScript definitions
|
|
373
|
+
├── tests/ # Integration tests
|
|
374
|
+
├── dist/ # Compiled output
|
|
375
|
+
├── wrangler.toml # Cloudflare config
|
|
376
|
+
├── tsconfig.json # TypeScript config
|
|
377
|
+
└── package.json # Project metadata
|
|
378
|
+
```
|
|
379
|
+
|
|
380
|
+
## Security
|
|
381
|
+
|
|
382
|
+
### Our Security Commitments
|
|
383
|
+
|
|
384
|
+
- **Local-Only Tokens** - Your API tokens never leave your machine
|
|
385
|
+
- **No Data Collection** - We don't track, log, or store any user data
|
|
386
|
+
- **Direct API Calls** - All platform APIs are called directly from your local MCP server
|
|
387
|
+
- **Open Source** - Full transparency with auditable code
|
|
388
|
+
- **Badge Service** - Coming in v0.2.0 with webhook-based live deployment badges
|
|
389
|
+
|
|
390
|
+
### Best Practices
|
|
391
|
+
|
|
392
|
+
1. **Use Read-Only Tokens** - When possible, create tokens with minimal permissions
|
|
393
|
+
2. **Rotate Tokens Regularly** - Update your tokens periodically
|
|
394
|
+
3. **Environment Variables** - Store tokens in environment variables, not in code
|
|
395
|
+
4. **Git Ignore** - Never commit configuration files with tokens
|
|
396
|
+
|
|
397
|
+
## Platform Support
|
|
398
|
+
|
|
399
|
+
<table>
|
|
400
|
+
<thead>
|
|
401
|
+
<tr>
|
|
402
|
+
<th>Platform</th>
|
|
403
|
+
<th>Status</th>
|
|
404
|
+
<th>Features</th>
|
|
405
|
+
<th>Documentation</th>
|
|
406
|
+
</tr>
|
|
407
|
+
</thead>
|
|
408
|
+
<tbody>
|
|
409
|
+
<tr>
|
|
410
|
+
<td><strong>Vercel</strong></td>
|
|
411
|
+
<td><strong>✓ Supported</strong></td>
|
|
412
|
+
<td>Full deployment tracking with real-time status updates</td>
|
|
413
|
+
<td><a href="https://deploy-mcp.io/docs/vercel">View Guide</a></td>
|
|
414
|
+
</tr>
|
|
415
|
+
<tr>
|
|
416
|
+
<td><strong>Netlify</strong></td>
|
|
417
|
+
<td><strong>Coming Soon</strong></td>
|
|
418
|
+
<td>In active development</td>
|
|
419
|
+
<td>Coming soon</td>
|
|
420
|
+
</tr>
|
|
421
|
+
<tr>
|
|
422
|
+
<td><strong>Railway</strong></td>
|
|
423
|
+
<td><strong>Planned</strong></td>
|
|
424
|
+
<td>On the roadmap</td>
|
|
425
|
+
<td>-</td>
|
|
426
|
+
</tr>
|
|
427
|
+
<tr>
|
|
428
|
+
<td><strong>Render</strong></td>
|
|
429
|
+
<td><strong>Planned</strong></td>
|
|
430
|
+
<td>On the roadmap</td>
|
|
431
|
+
<td>-</td>
|
|
432
|
+
</tr>
|
|
433
|
+
</tbody>
|
|
434
|
+
</table>
|
|
435
|
+
|
|
436
|
+
Want support for another platform? [Open an issue](https://github.com/alexpota/deploy-mcp/issues/new) or submit a PR\!
|
|
437
|
+
|
|
438
|
+
## Contributing
|
|
439
|
+
|
|
440
|
+
We love contributions\! Whether it's a bug fix, new feature, or platform support, we'd love to have you.
|
|
441
|
+
|
|
442
|
+
### Quick Start
|
|
443
|
+
|
|
444
|
+
1. Fork the repository
|
|
445
|
+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
|
|
446
|
+
3. Commit your changes (`git commit -m 'Add amazing feature'`)
|
|
447
|
+
4. Push to the branch (`git push origin feature/amazing-feature`)
|
|
448
|
+
5. Open a Pull Request
|
|
449
|
+
|
|
450
|
+
### Adding Platform Support
|
|
451
|
+
|
|
452
|
+
Want to add support for a new platform? Here's how:
|
|
453
|
+
|
|
454
|
+
1. **Create an adapter folder** in `src/adapters/your-platform/`
|
|
455
|
+
2. **Implement the interface**:
|
|
456
|
+
```typescript
|
|
457
|
+
export class YourPlatformAdapter extends BaseAdapter {
|
|
458
|
+
async getDeploymentStatus(project: string, token: string) {
|
|
459
|
+
// Your implementation
|
|
460
|
+
}
|
|
461
|
+
}
|
|
462
|
+
```
|
|
463
|
+
3. **Add tests** in `src/adapters/your-platform/__tests__/`
|
|
464
|
+
4. **Update docs** with setup instructions
|
|
465
|
+
5. **Submit a PR** and we'll review it\!
|
|
466
|
+
|
|
467
|
+
See our [Contributing Guide](CONTRIBUTING.md) for more details.
|
|
468
|
+
|
|
469
|
+
## License
|
|
470
|
+
|
|
471
|
+
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
|
|
472
|
+
|
|
473
|
+
## Acknowledgments
|
|
474
|
+
|
|
475
|
+
- Built with [Model Context Protocol SDK](https://github.com/modelcontextprotocol/sdk) by Anthropic
|
|
476
|
+
- Hosted on [Cloudflare Workers](https://workers.cloudflare.com) for global edge performance
|
|
477
|
+
- Icons from [Feather Icons](https://feathericons.com) and [Heroicons](https://heroicons.com)
|
|
478
|
+
|
|
479
|
+
## Community & Support
|
|
480
|
+
|
|
481
|
+
<div align="center">
|
|
482
|
+
<a href="https://github.com/alexpota/deploy-mcp/discussions">
|
|
483
|
+
<img src="https://img.shields.io/badge/GitHub-Discussions-181717?style=for-the-badge&logo=github" alt="GitHub Discussions" />
|
|
484
|
+
</a>
|
|
485
|
+
<a href="https://github.com/alexpota/deploy-mcp/issues">
|
|
486
|
+
<img src="https://img.shields.io/badge/Report-Issues-ff6b6b?style=for-the-badge&logo=github" alt="Report Issues" />
|
|
487
|
+
</a>
|
|
488
|
+
<a href="mailto:alex.potapenko.dev@gmail.com">
|
|
489
|
+
<img src="https://img.shields.io/badge/Email-alex.potapenko.dev@gmail.com-ff6b6b?style=for-the-badge&logo=gmail" alt="Email" />
|
|
490
|
+
</a>
|
|
491
|
+
</div>
|
|
492
|
+
|
|
493
|
+
---
|
|
494
|
+
|
|
495
|
+
<div align="center">
|
|
496
|
+
<p>Made with ❤️ by <a href="https://github.com/alexpota">Alex Potapenko</a> and contributors</p>
|
|
497
|
+
<p><a href="https://deploy-mcp.io">deploy-mcp.io</a> • <a href="https://github.com/alexpota/deploy-mcp">GitHub</a> • <a href="https://www.npmjs.com/package/deploy-mcp">NPM</a></p>
|
|
498
|
+
</div>
|
|
499
|
+
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
We take security seriously and provide security updates for the following versions:
|
|
6
|
+
|
|
7
|
+
| Version | Supported |
|
|
8
|
+
| ------- | ------------------ |
|
|
9
|
+
| 0.1.x | :white_check_mark: |
|
|
10
|
+
|
|
11
|
+
## Reporting a Vulnerability
|
|
12
|
+
|
|
13
|
+
If you discover a security vulnerability in deploy-mcp, please help us maintain the security of the project by reporting it responsibly.
|
|
14
|
+
|
|
15
|
+
### How to Report
|
|
16
|
+
|
|
17
|
+
**Please do not report security vulnerabilities through public GitHub issues.**
|
|
18
|
+
|
|
19
|
+
Instead, please send an email to: **alex.potapenko.dev@gmail.com**
|
|
20
|
+
|
|
21
|
+
Include the following information:
|
|
22
|
+
- Description of the vulnerability
|
|
23
|
+
- Steps to reproduce the issue
|
|
24
|
+
- Potential impact assessment
|
|
25
|
+
- Any suggested fixes or mitigations
|
|
26
|
+
|
|
27
|
+
### Response Timeline
|
|
28
|
+
|
|
29
|
+
- **Initial Response**: Within 48 hours of receiving your report
|
|
30
|
+
- **Status Update**: Weekly updates on investigation progress
|
|
31
|
+
- **Resolution**: Security fixes are prioritized and typically released within 7-14 days
|
|
32
|
+
|
|
33
|
+
### Disclosure Policy
|
|
34
|
+
|
|
35
|
+
- We will acknowledge receipt of your vulnerability report within 2 business days
|
|
36
|
+
- We will provide regular updates on our investigation and remediation timeline
|
|
37
|
+
- We will notify you when the vulnerability has been fixed
|
|
38
|
+
- We will publicly disclose the vulnerability details after a fix has been released and deployed
|
|
39
|
+
|
|
40
|
+
### Security Best Practices
|
|
41
|
+
|
|
42
|
+
When using deploy-mcp in production:
|
|
43
|
+
|
|
44
|
+
1. **API Token Security**: Store tokens in environment variables, never in code or version control
|
|
45
|
+
2. **Token Permissions**: Use read-only API tokens when possible to minimize risk
|
|
46
|
+
3. **Token Rotation**: Regularly rotate API tokens for enhanced security
|
|
47
|
+
4. **Network Security**: Ensure secure connections when accessing deployment platforms
|
|
48
|
+
5. **Updates**: Keep deploy-mcp and its dependencies up to date
|
|
49
|
+
|
|
50
|
+
### Security Features
|
|
51
|
+
|
|
52
|
+
deploy-mcp includes several security-conscious design decisions:
|
|
53
|
+
|
|
54
|
+
- **Local-only token storage** - API tokens never leave your machine
|
|
55
|
+
- **No data collection** - Zero tracking or analytics of user data
|
|
56
|
+
- **Direct API calls** - All requests go directly to deployment platforms
|
|
57
|
+
- **Input validation** using Zod schemas to prevent injection attacks
|
|
58
|
+
- **Minimal dependencies** to reduce supply chain risks
|
|
59
|
+
- **Strict TypeScript** compilation to catch potential issues at build time
|
|
60
|
+
|
|
61
|
+
Thank you for helping keep deploy-mcp and the Node.js ecosystem secure.
|