@digitalocean/mcp 1.0.0-aplha.2 → 1.0.0

package/README.md

@@ -0,0 +1,128 @@
+# MCP DigitalOcean Integration
+
+MCP DigitalOcean Integration is an open-source project that provides a comprehensive interface for managing DigitalOcean resources and performing actions using the [DigitalOcean API](https://docs.digitalocean.com/reference/api/). Built on top of the [godo](https://github.com/digitalocean/godo) library and the [MCP framework](https://github.com/mark3labs/mcp-go), this project exposes a wide range of tools to simplify cloud infrastructure management.
+
+> DISCLAIMER: “Use of MCP technology to interact with your DigitalOcean account [can come with risks](https://www.wiz.io/blog/mcp-security-research-briefing)”
+
+## Installation
+
+Prerequisites:
+
+- Node.js (v18 or later)
+- NPM (v8 or later)
+
+#### Local Installation
+
+```bash
+npx @digitalocean/mcp --services apps,droplets --log-level debug
+```
+
+#### Using Cursor IDE
+
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](cursor://anysphere.cursor-deeplink/mcp/install?name=digitalocean&config=eyJjb21tYW5kIjoibnB4IEBkaWdpdGFsb2NlYW4vbWNwIC0tc2VydmljZXMgYXBwcyIsImVudiI6eyJESUdJVEFMT0NFQU5fQVBJX1RPS0VOIjoiWU9VUl9ET19UT0tFTiJ9fQ%3D%3D)
+
+```json
+{
+  "mcpServers": {
+    "digitalocean": {
+      "command": "npx",
+      "args": ["@digitalocean/mcp", "--services apps"],
+      "env": {
+        "DIGITALOCEAN_API_TOKEN": "YOUR_API_TOKEN"
+      }
+    }
+  }
+}
+```
+
+#### Using VSCode
+```json
+{
+    "mcp": {
+        "inputs": [],
+        "servers": {
+            "mcpDigitalOcean": {
+                "command": "npx",
+                "args": [
+                    "@digitalocean/mcp",
+                    "--services",
+                    "apps"
+                ],
+                "env": {
+                    "DIGITALOCEAN_API_TOKEN": "YOUR_API_TOKEN"
+                }
+            }
+        }
+    }
+}
+```
+
+## Supported Services
+
+The MCP DigitalOcean Integration supports the following services, allowing users to manage their DigitalOcean infrastructure effectively
+
+
+| **Service**    | **Description**                                                                                                     |
+|----------------|---------------------------------------------------------------------------------------------------------------------|
+| **Apps**       | Manage DigitalOcean App Platform applications, including deployments and configurations.                            |
+| **Droplets**   | Create, manage, resize, snapshot, and monitor droplets (virtual machines) on DigitalOcean.                          |
+| **Account**    | Get information about your DigitalOcean account, billing, balance, invoices, and SSH keys.                          |
+| **Networking** | Manage domains, DNS records, certificates, firewalls, reserved IPs, VPCs, CDNs, and Partner Network attachments.    |
+| **Insights**   | Monitors your resources, endpoints and alert you when they're slow, unavailable, or SSL certificates are expiring.  |
+| **Spaces**     | DigitalOcean Spaces object storage and Spaces access keys for S3-compatible storage.                                |
+
+
+---
+### Service Documentation
+
+Each service provides a detailed README describing all available tools, resources, arguments, and example queries.
+See the following files for full documentation:
+
+- [Apps Service](./internal/apps/README.md)
+- [Droplet Service](./internal/droplet/README.md)
+- [Account Service](./internal/account/README.md)
+- [Networking Service](./internal/networking/README.md)
+- [DBaaS Service](./internal/dbaas/README.md)
+- [Insights Service](./internal/insights/README.md)
+- [Spaces Service](./internal/spaces/README.md)
+
+---
+
+### Example Tool Usage
+
+- Deploy an app from a GitHub repo: `digitalocean-create-app-from-spec`
+- Resize a droplet: `digitalocean-droplet-resize`
+- Add a new SSH key: `digitalocean-key-create`
+- Create a new domain: `digitalocean-domain-create`
+- Enable backups on a droplet: `digitalocean-droplet-enable-backups`
+- Flush a CDN cache: `digitalocean-cdn-flush-cache`
+- Create a VPC peering connection: `digitalocean-vpc-peering-create`
+- Delete a VPC peering connection: `digitalocean-vpc-peering-delete`
+
+---
+
+
+## Configuring Tools
+
+To configure tools, you use the `--services` flag to specify which service you want to enable. It is highly recommended to only
+enable the services you need to reduce context size and improve accuracy.
+
+```bash
+npx @digitalocean/mcp --services apps,droplets
+```
+
+---
+## Contributing
+
+Contributions are welcome! If you encounter any issues or have ideas for improvements, feel free to open an issue or submit a pull request.
+
+### How to Contribute
+1. Fork the repository.
+2. Create a new branch for your feature or bug fix.
+3. Submit a pull request with a clear description of your changes.
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "@digitalocean/mcp",
-  "version": "1.0.0-aplha.2",
+  "version": "1.0.0",
   "description": "DigitalOcean MCP Implementation,",
   "author": "DigitalOcean",
-  "readme": "../../README.md",
   "homepage": "https://github.com/digitalocean-labs/mcp-digitalocean?tab=readme-ov-file#mcp-digitalocean-integration",
   "license": "MIT",
   "keywords": [