Rundeck MCP Server

Rundeck MCP Server

By vanisoul GitHub

-

Overview

What is Rundeck MCP Server?

Rundeck MCP Server is a Model Context Protocol (MCP) server designed for interacting with the Rundeck CLI, allowing users to perform Rundeck operations without direct command line interaction.

How to use Rundeck MCP Server?

To use the Rundeck MCP Server, clone the repository, install dependencies, build the project, and configure the MCP settings file with the appropriate paths and API token. Once configured, you can call MCP tools using specific commands.

Key features of Rundeck MCP Server?

  • Job management: List, get information, execute, and forecast jobs.
  • Execution management: List, get information, retrieve output, and track executions.
  • Project management: List and get information about projects.
  • Node and system information: List nodes and retrieve system information.

Use cases of Rundeck MCP Server?

  1. Automating job execution in Rundeck projects.
  2. Monitoring and managing Rundeck executions in real-time.
  3. Simplifying project management through automated commands.

FAQ from Rundeck MCP Server?

  • What are the prerequisites for using Rundeck MCP Server?

You need Node.js (v14 or higher) and the Rundeck CLI tool installed.

  • How do I install Rundeck CLI?

Follow the installation guide at https://docs.rundeck.com/docs/rd-cli/install.html.

  • What should I do if I encounter issues?

Check the configuration of your Rundeck CLI path, base URL, and API token.

Content

Rundeck MCP Server

This is a Model Context Protocol (MCP) server for interacting with the Rundeck CLI. It provides a set of tools that allow you to perform Rundeck operations with AI without directly interacting with the command line.

Features

  • Jobs Management: List, get information, execute, and predict
  • Executions Management: List, get information, get output, and track
  • Projects Management: List and get information
  • Nodes and System Information: List nodes and get system information

Installation

Prerequisites

  • Node.js (v14 or higher)
  • Rundeck CLI tool

Steps

  1. Clone this repository:
git clone https://github.com/vanisoul/rundeck-mcp-server
cd rundeck-mcp-server
  1. Install dependencies:
npm install
  1. Build the project:
npm run build
  1. 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
  1. Restart VS Code or Claude Desktop for the settings to take effect.

How to Install Rundeck CLI

Troubleshooting

If you encounter issues, check the following:

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

License

MIT

No tools information available.
No content found.