MCP Opsbeacon Server

🚀 MCP Operations Order Server

An implementation of the Model Context Protocol (MCP) server for Opsbeacon operations. This server allows you to interact with the Opsbeacon API via Claude, providing functions such as listing commands and connections.

✨ Features

• List available Opsbeacon commands.
• List available Opsbeacon connections.
• Authenticate using a bearer token.
• Handle errors and log information.
• Return structured JSON responses.

📦 Installation

Prerequisites

• Python 3.10 or higher.
• Access to the Opsbeacon API.
• A valid bearer token.

Steps

1. Clone the repository:

git clone [repository-url]
cd mcp-opsbeacon-server

2. Install the package:

pip install -e .

Configuration

There are three ways to provide your Opsbeacon configuration:

Option 1: Use with Claude Desktop

If you want to use the MCP server with Claude, add the required configuration to the Claude Desktop configuration file:

{
  "mcpServers": {
    "opsbeacon": {
      "command": "python",
      "args": [
        "-m",
        "mcp_opsbeacon_server"
      ],
      "env": {
        "OPSBEACON_TOKEN": "your-bearer-token-here",
        "OPSBEACON_BASE_URL": "your-base-url-here"
      }
    }
  }
}

Option 2: Use Environment Variables

You can directly set the required environment variables:

export OPSBEACON_TOKEN="your-bearer-token-here"
export OPSBEACON_BASE_URL="your-base-url-here"

Option 3: Use a .env File (Recommended for Development)

Create a .env file in the project root directory. You can use the provided template:

cp .env.example .env

Then edit the .env file and enter the actual values:

OPSBEACON_TOKEN=your-bearer-token-here
OPSBEACON_BASE_URL=your-base-url-here  # Optional, default is https://api.console.opsbeacon.com

The .env file is ignored by git to prevent committing sensitive information.

Base URL Configuration

The OPSBEACON_BASE_URL configuration is optional. If not specified, the following URL is used by default:

https://api.console.opsbeacon.com

You can override this default value through any configuration method (such as environment variables or a .env file).

Configuration Priority

You can use these options simultaneously. When multiple options are used, the priority order is as follows:

1. Environment variables
2. .env file
3. Claude configuration file
4. Default base URL

Testing

To test the server functionality, ensure that the required variables are configured (it is recommended to use a .env file in development), and then run:

python test_server.py

💻 Usage Examples

Available Tools

1. list_commands

   • Lists all available Opsbeacon commands.
   • No additional parameters are required.
   • Returns detailed command information (in JSON format).

2. list_connections

   • Lists all available Opsbeacon connections.
   • No additional parameters are required.
   • Returns detailed connection information (in JSON format).

Example Usage with Claude

Human: List commands.
Claude: Run the following command: `list_commands`

Result:
Returns a list of all available commands.

Error Handling

• If you do not have a valid bearer token, you will not be able to access protected endpoints.
• If the base URL is invalid or the server cannot be connected to, a connection error may occur.
• If the request parameters are invalid, a validation error may be returned.

Development

To add new features or modify existing code, follow these steps:

1. Clone the repository and install the dependencies.
2. Modify the code to implement the desired functionality.
3. Add test cases to ensure that the functionality works correctly.
4. Commit the changes and create a pull request.

After completion, it is recommended to update the documentation to reflect any new features or changes.