J
MCPRules
...
Created 12/17/2024bybartwisch
Language:
JavaScript
Stars:
15
Forks:
3
MCPRules - Programming Guidelines Management Server
A powerful Model Context Protocol (MCP) server that manages and serves programming guidelines and rules. This server integrates with development tools to provide consistent coding standards across projects.
Features
-
Rule Management
- Access rules via MCP tools
- Filter rules by categories
- Support for both local and GitHub-hosted rules
- Structured rule format with categories and key-value pairs
-
Flexible Storage
- Local file system support
- GitHub repository integration
- Markdown-based rule definitions
-
Category Organization
- Core Programming Principles
- Code Style and Formatting
- Language-Specific Guidelines
- Project Management Rules
- Operating System Specific Rules
Installation
-
Clone the Repository
git clone https://github.com/yourusername/MCPRules.git cd MCPRules/rules-server
-
Install Dependencies
npm install
-
Build the Server
npm run build
-
Configure Environment Variables
export RULES_FILE_PATH=/path/to/your/rules.md # Optional for private GitHub repositories export GITHUB_TOKEN=your_github_token
Configuration
For VSCode Cline Extension
Location: ~/Library/Application Support/Windsurf/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json
{
"mcpServers": {
"rules": {
"command": "node",
"args": ["/path/to/rules-server/build/index.js"],
"disabled": false,
"alwaysAllow": []
}
}
}
For Claude Desktop
Location: `~/Library/Application Support/Claude/claude_desktop_config.json`
Usage
Available Tools
-
Get Rules
// Retrieve all rules or filter by category { "category": "optional-category-name" }
-
Get Categories
// List all available rule categories {}
Rule Format
Rules are stored in markdown files with the following structure:
#Category
key: value
Development
-
Watch Mode
npm run watch
-
Debugging
npm run inspector
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature
) - Commit your changes (
git commit -m 'Add some AmazingFeature'
) - Push to the branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgments
- Credits to the original rules from Reddit discussion
- Thanks to the Model Context Protocol community
Last updated: 3/1/2025