46 lines
1.4 KiB
Markdown
46 lines
1.4 KiB
Markdown
# Coolify MCP Server (Node.js)
|
|
|
|
A Node.js MCP server CLI for interacting with the Coolify API, runnable via npx, Docker, or docker-compose.
|
|
|
|
## Usage
|
|
|
|
### With npx
|
|
```sh
|
|
npx coolify-mcp-xavis <command> [subcommand] --host_url <COOLIFY_HOST_URL> --token <COOLIFY_API_TOKEN>
|
|
```
|
|
|
|
### With Docker
|
|
```sh
|
|
docker build -t coolify-mcp-xavis .
|
|
docker run --rm coolify-mcp-xavis <command> [subcommand] --host_url <COOLIFY_HOST_URL> --token <COOLIFY_API_TOKEN>
|
|
```
|
|
|
|
### With Docker Compose
|
|
Create a `.env` file:
|
|
```
|
|
HOST_URL=https://your-coolify-instance.com
|
|
TOKEN=your-coolify-api-token
|
|
```
|
|
Then run:
|
|
```sh
|
|
docker-compose run mcp-server <command> [subcommand]
|
|
```
|
|
|
|
## Parameters
|
|
- `--host_url` (required): The base URL of your Coolify API (e.g., https://coolify.example.com)
|
|
- `--token` (required): The API token for authentication
|
|
|
|
## Example
|
|
```
|
|
npx coolify-mcp-xavis health --host_url https://coolify.example.com --token abc123
|
|
```
|
|
|
|
## OpenAPI Coverage
|
|
All tools and endpoints described in the [Coolify OpenAPI v4.x](https://github.com/coollabsio/coolify-docs/blob/v4.x/docs/public/openapi.yml) are implemented and available as CLI subcommands. Each tool is fully documented with parameter formats and usage examples (see JSDoc in `src/tools/`).
|
|
|
|
## Extending
|
|
- The CLI supports all Coolify API endpoints. To add new endpoints, extend the corresponding file in `src/tools/` and update the CLI in `src/index.js`.
|
|
|
|
## License
|
|
MIT
|