Project

status_mcp

0.0
No release in over 3 years
Ruby gem providing status page information from awesome-status via MCP server tools.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 2.5
~> 13.3
~> 3.9
~> 3.13
~> 0.22
~> 1.52
~> 6.3
~> 3.26

Runtime

~> 0.3
~> 1.6
~> 1.18
~> 3.2
 Project Readme

status_mcp

Gem Version Test Status codecov

Ruby gem providing status page information from awesome-status via MCP (Model Context Protocol) server tools. Integrates with MCP-compatible clients like Cursor IDE, Claude Desktop, and other MCP-enabled tools.

Sponsored by Kisko Labs.

Sponsored by Kisko Labs

Requirements

  • Ruby 3.1 or higher (Ruby 3.0 and earlier are not supported)

Quick Start

gem install status_mcp

Cursor IDE Configuration

For Cursor IDE, create or update .cursor/mcp.json in your project:

{
  "mcpServers": {
    "status": {
      "command": "gem",
      "args": ["exec", "status_mcp"],
      "env": {
        "RUBY_VERSION": "3.4.7"
      }
    }
  }
}

Note: Using gem exec ensures the correct Ruby version is used.

Claude Desktop Configuration

For Claude Desktop, edit the MCP configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "status": {
      "command": "gem",
      "args": ["exec", "status_mcp"],
      "env": {
        "RUBY_VERSION": "3.4.7"
      }
    }
  }
}

Note: After updating the configuration, restart Claude Desktop for changes to take effect.

Running the MCP Server manually

After installation, you can start the MCP server immediately:

# With bundler
gem install status_mcp && bundle exec status_mcp

# Or if installed globally
status_mcp

The server will start and communicate via STDIN/STDOUT using the MCP protocol.

Features

  • Status Page Information: Access to over 1700 status page links from awesome-status
  • MCP Server Integration: Ready-to-use MCP server with tools for searching and retrieving status page details
  • No Authentication Required: All data is bundled with the gem
  • Offline Capable: Once installed, the data is available locally

MCP Tools

The MCP server provides the following tools:

  1. search_services - Search for services by name

    • Parameters: query (string)
  2. get_service_details - Get detailed status links for a specific service

    • Parameters: name (string)
  3. list_services - List all available services (limited to first 50 if too many)

    • Parameters: limit (optional integer, default: 50)

Development

# Install dependencies
bundle install

# Run tests
bundle exec rspec

# Run tests across multiple Ruby versions
bundle exec appraisal install
bundle exec appraisal rspec

# Run linting
bundle exec standardrb --fix

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/amkisko/status_mcp.rb.

For more information, see CONTRIBUTING.md.

Security

If you discover a security vulnerability, please report it responsibly. See SECURITY.md for details.

License

The gem is available as open source under the terms of the MIT License.