status_mcp 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +12 -0
- data/LICENSE.md +21 -0
- data/README.md +129 -0
- data/assets/data.json +17536 -0
- data/bin/status_mcp +14 -0
- data/lib/status_mcp/server.rb +1253 -0
- data/lib/status_mcp/version.rb +5 -0
- data/lib/status_mcp.rb +22 -0
- metadata +260 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 90ebc8381fe57ee101567bd64e18bc376d891bedbfa5082e82588494390576b3
|
|
4
|
+
data.tar.gz: 7ac9f6100c97338d2e1db437baf9cd4a5c9c54170d449b76324a94c59f10fd81
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 3a080023fd1c648d0820ebbf1701689dc8fb7fff2e6bfcb371b7a75b8b38de92d76c4aa2c67c34309a2b672cd399f4315c08ab3d06b13411c6eb35a296ab9350
|
|
7
|
+
data.tar.gz: 10b97c76cea65e18588eff67c1874d3803113e5ca6c4559af0f35c72bbf389e1230a4caffec32c89e8df732ddc993d1fed98cfd9fcdec9121d599c6d87a6dde4
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CHANGELOG
|
|
2
|
+
|
|
3
|
+
## 0.1.0 (2025-11-26)
|
|
4
|
+
|
|
5
|
+
- Initial release
|
|
6
|
+
- MCP server with tools:
|
|
7
|
+
- `search_services`: Search for services by name
|
|
8
|
+
- `get_service_details`: Get detailed status links for a specific service
|
|
9
|
+
- `list_services`: List all available services
|
|
10
|
+
- Data update script `bin/update_status_list` to fetch data from `awesome-status`
|
|
11
|
+
- Comprehensive test suite with RSpec
|
|
12
|
+
- Full documentation and CI/CD setup
|
data/LICENSE.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# status_mcp
|
|
2
|
+
|
|
3
|
+
[](https://badge.fury.io/rb/status_mcp) [](https://github.com/amkisko/status_mcp.rb/actions/workflows/test.yml) [](https://codecov.io/gh/amkisko/status_mcp.rb)
|
|
4
|
+
|
|
5
|
+
Ruby gem providing status page information from [awesome-status](https://github.com/amkisko/awesome-status) via MCP (Model Context Protocol) server tools. Integrates with MCP-compatible clients like Cursor IDE, Claude Desktop, and other MCP-enabled tools.
|
|
6
|
+
|
|
7
|
+
Sponsored by [Kisko Labs](https://www.kiskolabs.com).
|
|
8
|
+
|
|
9
|
+
<a href="https://www.kiskolabs.com">
|
|
10
|
+
<img src="kisko.svg" width="200" alt="Sponsored by Kisko Labs" />
|
|
11
|
+
</a>
|
|
12
|
+
|
|
13
|
+
## Requirements
|
|
14
|
+
|
|
15
|
+
- **Ruby 3.1 or higher** (Ruby 3.0 and earlier are not supported)
|
|
16
|
+
|
|
17
|
+
## Quick Start
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
gem install status_mcp
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### Cursor IDE Configuration
|
|
24
|
+
|
|
25
|
+
For Cursor IDE, create or update `.cursor/mcp.json` in your project:
|
|
26
|
+
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"mcpServers": {
|
|
30
|
+
"status": {
|
|
31
|
+
"command": "gem",
|
|
32
|
+
"args": ["exec", "status_mcp"],
|
|
33
|
+
"env": {
|
|
34
|
+
"RUBY_VERSION": "3.4.7"
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
**Note**: Using `gem exec` ensures the correct Ruby version is used.
|
|
42
|
+
|
|
43
|
+
### Claude Desktop Configuration
|
|
44
|
+
|
|
45
|
+
For Claude Desktop, edit the MCP configuration file:
|
|
46
|
+
|
|
47
|
+
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
48
|
+
**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
49
|
+
|
|
50
|
+
```json
|
|
51
|
+
{
|
|
52
|
+
"mcpServers": {
|
|
53
|
+
"status": {
|
|
54
|
+
"command": "gem",
|
|
55
|
+
"args": ["exec", "status_mcp"],
|
|
56
|
+
"env": {
|
|
57
|
+
"RUBY_VERSION": "3.4.7"
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
**Note**: After updating the configuration, restart Claude Desktop for changes to take effect.
|
|
65
|
+
|
|
66
|
+
### Running the MCP Server manually
|
|
67
|
+
|
|
68
|
+
After installation, you can start the MCP server immediately:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
# With bundler
|
|
72
|
+
gem install status_mcp && bundle exec status_mcp
|
|
73
|
+
|
|
74
|
+
# Or if installed globally
|
|
75
|
+
status_mcp
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
The server will start and communicate via STDIN/STDOUT using the MCP protocol.
|
|
79
|
+
|
|
80
|
+
## Features
|
|
81
|
+
|
|
82
|
+
- **Status Page Information**: Access to over 1700 status page links from `awesome-status`
|
|
83
|
+
- **MCP Server Integration**: Ready-to-use MCP server with tools for searching and retrieving status page details
|
|
84
|
+
- **No Authentication Required**: All data is bundled with the gem
|
|
85
|
+
- **Offline Capable**: Once installed, the data is available locally
|
|
86
|
+
|
|
87
|
+
## MCP Tools
|
|
88
|
+
|
|
89
|
+
The MCP server provides the following tools:
|
|
90
|
+
|
|
91
|
+
1. **search_services** - Search for services by name
|
|
92
|
+
- Parameters: `query` (string)
|
|
93
|
+
|
|
94
|
+
2. **get_service_details** - Get detailed status links for a specific service
|
|
95
|
+
- Parameters: `name` (string)
|
|
96
|
+
|
|
97
|
+
3. **list_services** - List all available services (limited to first 50 if too many)
|
|
98
|
+
- Parameters: `limit` (optional integer, default: 50)
|
|
99
|
+
|
|
100
|
+
## Development
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
# Install dependencies
|
|
104
|
+
bundle install
|
|
105
|
+
|
|
106
|
+
# Run tests
|
|
107
|
+
bundle exec rspec
|
|
108
|
+
|
|
109
|
+
# Run tests across multiple Ruby versions
|
|
110
|
+
bundle exec appraisal install
|
|
111
|
+
bundle exec appraisal rspec
|
|
112
|
+
|
|
113
|
+
# Run linting
|
|
114
|
+
bundle exec standardrb --fix
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## Contributing
|
|
118
|
+
|
|
119
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/amkisko/status_mcp.rb.
|
|
120
|
+
|
|
121
|
+
For more information, see [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
122
|
+
|
|
123
|
+
## Security
|
|
124
|
+
|
|
125
|
+
If you discover a security vulnerability, please report it responsibly. See [SECURITY.md](SECURITY.md) for details.
|
|
126
|
+
|
|
127
|
+
## License
|
|
128
|
+
|
|
129
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|