Style Guidelines

🚀 MCPRules - Programming Specification Management Server

A powerful Model Context Protocol (MCP) server for managing and providing programming guidelines and rules. This server integrates with development tools to enforce consistent coding standards across projects.

✨ Features

• Rule Management

  • Access rules via MCP tools.
  • Filter rules by category.
  • Support rules hosted locally or on GitHub.
  • Structured rule format with categories and key - value pairs.

• Flexible Storage

  • Support for local file systems.
  • Integration with GitHub repositories.
  • Rule definitions based on Markdown.

• Category Organization

  • Core programming principles.
  • Code style and formatting.
  • Language - specific guidelines.
  • Project management rules.
  • Operating system - specific rules.

📦 Installation

1. Clone the repository

   git clone https://github.com/yourusername/MCPRules.git
   cd MCPRules/rules-server
   

2. Install dependencies

   npm install
   

3. Build the server

   npm run build
   

4. Configure environment variables

   export RULES_FILE_PATH=/path/to/your/rules.md
   # Optional, for private GitHub repositories
   export GITHUB_TOKEN=your_github_token
   

📚 Documentation

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": []
    }
  }
}

Configuration for Claude Desktop

Location: ~/Library/Application Support/Claude/claude_desktop_config.json

💻 Usage Examples

Available Tools

Basic Usage

// Get all rules or filter by category
{
  "category": "optional-category-name"
}

Advanced Usage

// List all available rule categories
{}

Rule Format

Rules are stored in Markdown files with the following structure:

#Category
key: value

🔧 Technical Details

Development

• Watch mode

  npm run watch
  

• Debugging

  npm run inspector
  

🤝 Contribution

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/AmazingFeature).
3. Commit your changes (git commit -m 'Add some AmazingFeature').
4. Push to the branch (git push origin feature/AmazingFeature).
5. Open a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Thanks to the original rules from the Reddit discussion Reddit Discussion.
• Thanks to the Model Context Protocol community.