Skip to content

MCP-README.md

Latest commit

 

History

History
167 lines (117 loc) · 3.41 KB

MCP-README.md

File metadata and controls

167 lines (117 loc) · 3.41 KB

WP Code Check - MCP Server

Model Context Protocol (MCP) server for WP Code Check

This server exposes WP Code Check scan results as MCP resources, allowing AI assistants like Claude Desktop and Cline to directly access and analyze your WordPress code quality scans.

🚀 Quick Start

1. Install Dependencies

# From the repository root
npm install

2. Configure Your AI Assistant

Claude Desktop (macOS)

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

{
  "mcpServers": {
    "wp-code-check": {
      "command": "node",
      "args": [
        "/absolute/path/to/wp-code-check/dist/bin/mcp-server.js"
      ]
    }
  }
}

Claude Desktop (Windows)

Edit %APPDATA%\Claude\claude_desktop_config.json:

{
  "mcpServers": {
    "wp-code-check": {
      "command": "node",
      "args": [
        "C:\\absolute\\path\\to\\wp-code-check\\dist\\bin\\mcp-server.js"
      ]
    }
  }
}

Cline (VS Code)

Add to Cline MCP settings:

{
  "mcpServers": {
    "wp-code-check": {
      "command": "node",
      "args": [
        "/absolute/path/to/wp-code-check/dist/bin/mcp-server.js"
      ]
    }
  }
}

Important: Always use absolute paths, not relative paths or ~.

3. Run a Scan

./dist/bin/check-performance.sh --paths /path/to/your/plugin

4. Ask Your AI Assistant

In Claude Desktop or Cline:

  • "Show me the latest WP Code Check scan results"
  • "What are the critical issues in the latest scan?"
  • "Summarize the findings from wpcc://latest-scan"
  • "What's in the latest HTML report?"

📚 Available Resources

Resource URI Description MIME Type
wpcc://latest-scan Most recent JSON scan log application/json
wpcc://latest-report Most recent HTML report text/html
wpcc://scan/{scan-id} Specific scan by timestamp ID application/json

Example Scan IDs:

  • 2026-01-13-031719-UTC
  • 2026-01-12-155649-UTC

🧪 Testing

# 1. Run a test scan
./dist/bin/check-performance.sh --paths ./dist/tests/fixtures

# 2. Start MCP server manually (for debugging)
node dist/bin/mcp-server.js
# Should output: "WP Code Check MCP Server running on stdio"

# 3. Test with your AI assistant
# Ask: "Read wpcc://latest-scan and summarize the findings"

🔧 Troubleshooting

"No scan results found"

Solution: Run a scan first:

./dist/bin/check-performance.sh --paths /path/to/plugin

"Cannot find module '@modelcontextprotocol/sdk'"

Solution: Install dependencies:

npm install

"Command not found: node"

Solution: Install Node.js 18+ from nodejs.org

AI assistant doesn't see the server

Solution:

  1. Verify absolute paths in config (no ~ or relative paths)
  2. Restart your AI assistant after config changes
  3. Check logs in AI assistant settings

📖 Documentation

🤝 Support

License: Apache-2.0
Version: 1.0.0 (Tier 1 - Basic Resources)