Style Guidelines MCP server

MCPRules serves as a Model Context Protocol (MCP) server that manages programming guidelines and rules. It integrates with development tools to provide consistent coding standards across projects by storing rules in a structured format and making them accessible via MCP-compatible applications.

Installation

Clone and Setup

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
   

Configuration

VSCode Cline Extension Setup

Configure the MCP server in your VSCode Cline extension settings:

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

Claude Desktop Integration

The server can be configured for Claude Desktop at:

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

Usage

Working with Rules

The server supports two main operations:

1. Get Rules

   To retrieve all rules or filter by category:

   {
     "category": "optional-category-name"
   }
   

2. Get Categories

   To list all available rule categories:

   {}
   

Rule Structure

Rules are stored in markdown files with a simple structure:

#Category
key: value

Supported 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 Options

  • 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

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "rules" '{"command":"node","args":["/path/to/rules-server/build/index.js"],"disabled":false,"alwaysAllow":[]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "rules": {
            "command": "node",
            "args": [
                "/path/to/rules-server/build/index.js"
            ],
            "disabled": false,
            "alwaysAllow": []
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

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

2. Add this to your configuration file:

{
    "mcpServers": {
        "rules": {
            "command": "node",
            "args": [
                "/path/to/rules-server/build/index.js"
            ],
            "disabled": false,
            "alwaysAllow": []
        }
    }
}

3. Restart Claude Desktop for the changes to take effect