Ravelry

🚀 Ravelry MCP Server

A server based on the Model Context Protocol (MCP) that provides tools to interact with the Ravelry API, allowing AI assistants to search, explore, and obtain knitting patterns.

🚀 Quick Start

This server, built with TypeScript and Node.js, enables AI assistants to interact with the Ravelry API via the Model Context Protocol (MCP). Its main functions include searching for knitting patterns, retrieving detailed information, and supporting multi - mode queries.

✨ Features

• Search Patterns: Search for knitting patterns based on keywords.
• Get Detailed Information: Retrieve detailed information about specific patterns.
• Batch Query: Obtain detailed information for multiple patterns at once.
• Filter Function: Support filtering by craft type (e.g., knitting or crochet) and price.

📦 Installation

Prerequisites

1. Install Node.js and npm (version 14 or higher is recommended).
2. Install TypeScript and other project dependencies.
3. Configure Ravelry API credentials.

Steps

1. Clone the repository:

   git clone https://github.com/your-repository.git
   cd your-repository
   

2. Install dependencies:

   npm install
   

3. Configure environment variables.

💻 Usage Examples

Development Mode

npm run dev

Production Mode

npm start

📚 Documentation

Integration Guide

Integrate the server as an MCP tool into an AI system and call functions through the following interfaces:

• search-patterns: Search for patterns.
• get-pattern-details: Get detailed information about a specific pattern.
• get-multiple-pattern-details: Batch get detailed information about multiple patterns.

Available Tools

search-patterns

Search for knitting patterns based on keywords.

Parameters:

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

get-pattern-details

Get detailed information about a specific pattern.

Parameters:

• id: Pattern ID (required)

get-multiple-pattern-details

Batch get detailed information about multiple patterns.

Parameters:

• ids: Array of pattern IDs (required)

How It Works

1. Use Basic Auth authentication to access the Ravelry API.
2. Call relevant endpoints of the Ravelry API.
3. Parse and return structured data.
4. Expose tools through the MCP interface for AI assistants to call.

Project Structure

src/
  ├── class/
  │   └── ravelry.class.ts       # Main Ravelry client implementation
  ├── endpoints/
  │   ├── getMultiplePatternDetails.ts  # Interface to batch get pattern details
  │   ├── getPatternDetails.ts         # Interface to get details of a single pattern
  │   ├── searchPatterns.ts           # Interface to search for patterns
  │   └── index.ts                    # Endpoint export file
  ├── types/
  │   ├── patternDetailed.d.ts       # Detailed pattern type definition
  │   └── patternSimple.d.ts         # Simple pattern type definition
  └── index.ts                      # Entry point and MCP server setup

Development Information

Environment Configuration

• .env.development: Used in development mode.
• .env.production: Used in production mode.

Testing

Run the test suite:

npm test

Formatting and Code Checking

# Run ESLint
npm run lint

# Fix ESLint errors
npm run lint:fix

# Format code using Prettier
npm run format

Deployment Notes

1. Ensure that the .env.production file contains valid Ravelry credentials.
2. Credentials will be embedded in the compiled code during the build process.
3. Use npm run prod for deployment.

📄 License

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