Rundeck MCP Server

🚀 Rundeck MCP Server

This is a Model Context Protocol (MCP) server designed to interact with the Rundeck CLI. It offers a suite of tools that enable you to perform Rundeck operations via AI, eliminating the need for direct command-line interaction.

✨ Features

• Job Management: List, retrieve information, execute, and predict jobs.
• Execution Management: List, retrieve information, obtain output, and track executions.
• Project Management: List and retrieve information about projects.
• Node and System Information: List nodes and obtain system information.

📦 Installation

Prerequisites

• Node.js (v14 or higher)
• Rundeck command-line interface tool

Steps

1. Clone this repository:

git clone https://github.com/vanisoul/rundeck-mcp-server
cd rundeck-mcp-server

2. Install dependencies:

npm install

3. Build the project:

npm run build

4. Configure the MCP settings file: Add the following configuration to your MCP settings file. The location of the settings file depends on your environment.

{
  "mcpServers": {
    "rundeck": {
      "command": "node",
      "args": ["/path/to/rundeck-mcp-server/build/index.js"],
      "env": {
        "RUNDECK_CLI_PATH": "/usr/bin/rd",
        "RUNDECK_BASE_URL": "http://your-rundeck-server:port/",
        "RUNDECK_API_TOKEN": "your-api-token"
      },
      "disabled": false,
      "alwaysAllow": []
    }
  }
}

Make sure to replace the following values:

• /path/to/rundeck-mcp-server/build/index.js: The absolute path to the built index.js file.
• /usr/bin/rd: The absolute path to the Rundeck CLI tool.
• http://your-rundeck-server:port/: Your Rundeck server URL.
• your-api-token: Your Rundeck API token.

5. Restart VS Code or Claude Desktop for the settings to take effect.

How to Install Rundeck CLI

• https://docs.rundeck.com/docs/rd-cli/install.html

🛠️ Troubleshooting

If you encounter issues, check the following:

1. Ensure that the Rundeck CLI tool is available and working properly.
2. Ensure that the RUNDECK_CLI_PATH environment variable points to the correct path of the Rundeck CLI tool.
3. Ensure that the RUNDECK_BASE_URL and RUNDECK_API_TOKEN environment variables are set correctly.
4. Check if the MCP settings file is configured correctly.

📄 License

MIT