Ravelry MCP server

The Ravelry MCP Server provides an interface between AI assistants and the Ravelry API, making it possible to search for, explore, and retrieve knitting and crochet patterns through the Model Context Protocol (MCP).

Prerequisites

Before installing the Ravelry MCP Server, ensure you have:

• Node.js (v14 or higher)
• npm or yarn
• Ravelry API credentials (username and password)

Installation

Step 1: Clone the repository

git clone <repository-url>
cd ravelry-mcp

Step 2: Install dependencies

npm install

Step 3: Set up environment variables

# Create development environment file
cp .env.example .env.development
# Create production environment file
cp .env.example .env.production

Step 4: Configure API credentials

Get your Ravelry username and password and add them to both environment files:

AUTH_USER=your_ravelry_username
AUTH_PASS=your_ravelry_password

Running the Server

Development Mode

To start the server with hot reload functionality:

npm run dev

Production Mode

Build and start the server for production use:

npm run build
npm start

Or use the shorthand command:

npm run prod

Integrating with Claude Desktop

To enable Ravelry browsing capabilities in Claude:

Step 1: Start the MCP server

Ensure your server is running locally or on an accessible remote host.

Step 2: Open Claude Desktop settings

• Launch Claude Desktop
• Click on your profile picture in the top right
• Select "Settings" from the dropdown menu

Step 3: Navigate to Extensions settings

• In the Settings sidebar, click on "Extensions"
• Select "Add Custom MCP"

Step 4: Configure the MCP connection

Option 1: Using the UI

• Name: Ravelry MCP (or any preferred name)
• URL: Enter the server URL (e.g., http://localhost:3000 for local development)
• Click "Add MCP"

Option 2: Using configuration command

• Build the project first
• Add to your Claude Desktop configuration:

"ravelry": {
  "command": "node",
  "args": [
    "YOUR_CUSTOM_PATH/dist/index.js"
  ]
}

Step 5: Enable the MCP

• Toggle the switch next to your newly added Ravelry MCP to enable it

Step 6: Verify connection

• Start a new conversation with Claude
• Ask: "Can you help me find some knitting patterns on Ravelry?"
• Claude should now be able to use the Ravelry tools

Troubleshooting

If Claude cannot connect to your MCP server, check that:

• The server is running and accessible
• The correct URL is configured in Claude Desktop settings
• Your API credentials are valid and properly configured

Available Tools

The server provides these tools for AI assistants:

search-patterns

Searches for patterns based on query parameters.

Parameters:

• query: Search term (required)
• page: Page number for pagination (default: 1)
• craft: Craft type (e.g., "knitting", "crochet")
• availability: Price filter (default: "free", options: "free", "ravelry", "online")

get-pattern-details

Retrieves detailed information for a specific pattern.

Parameters:

• id: Pattern ID (required)

get-multiple-pattern-details

Retrieves details for multiple patterns at once.

Parameters:

• ids: Array of pattern IDs (required)

Usage Examples with Claude

Once connected, you can ask Claude:

• "Find me some free crochet hat patterns on Ravelry"
• "Search for knitting patterns for socks"
• "Get more details about pattern ID 12345"
• "Find patterns that are suitable for beginners"

The server supports various filtering options including:

• Craft filtering: Specify knitting or crochet patterns
• Price options: Filter by free or paid patterns
• Difficulty levels: Find patterns suitable for different skill levels

How to add this MCP server to 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 > MCP and click "Add new global MCP server".

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

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

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 explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.