Ravelry

🚀 Ravelry MCP サーバー

このサーバーは、モデルコンテキストプロトコル (MCP) に基づいて構築されており、Ravelry API とのやり取りを可能にするツールを提供します。AI アシスタントが編み物パターンを検索、探索、取得できるようになります。

🚀 クイックスタート

Ravelry MCP サーバーは、TypeScript と Node.js を使用して構築されたサーバーで、AI アシスタントが Model Context Protocol (MCP) を通じて Ravelry API とやり取りできるようにします。主な機能には、編み物パターンの検索、詳細情報の取得、多モードクエリのサポートが含まれます。

✨ 主な機能

• パターン検索：キーワードに基づいて編み物パターンを検索します。
• 詳細情報の取得：特定のパターンの詳細情報を取得します。
• 一括クエリ：一度に複数のパターンの詳細情報を取得します。
• フィルタ機能：工芸タイプ（編み物や鉤針編みなど）や価格でのフィルタリングをサポートします。

📦 インストール

前提条件

1. Node.js と npm をインストールします（バージョン 14 以上を推奨）。
2. TypeScript とその他のプロジェクト依存関係をインストールします。
3. Ravelry API の認証情報を設定します。

手順

1. リポジトリをクローンします：

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

2. 依存関係をインストールします：

   npm install
   

3. 環境変数を設定します。

💻 使用例

開発モード

npm run dev

本番モード

npm start

📚 ドキュメント

統合ガイド

このサーバーを MCP ツールとして AI システムに統合し、以下のインターフェースを介して機能を呼び出します：

• search-patterns：パターンを検索します。
• get-pattern-details：特定のパターンの詳細情報を取得します。
• get-multiple-pattern-details：複数のパターンの詳細情報を一括で取得します。

利用可能なツール

search-patterns

キーワードに基づいて編み物パターンを検索します。 パラメータ：

• query：検索キーワード（必須）
• page：ページ番号（デフォルト：1）
• craft：工芸タイプ（例：“knitting” または “crochet”）
• availability：価格フィルタ（デフォルト：無料、オプションには “free”、“ravelry”、“online” が含まれます）

get-pattern-details

特定のパターンの詳細情報を取得します。 パラメータ：

• id：パターン ID（必須）

get-multiple-pattern-details

複数のパターンの詳細情報を一括で取得します。 パラメータ：

• ids：パターン ID の配列（必須）

仕組み

1. Basic Auth 認証を使用して Ravelry API にアクセスします。
2. Ravelry API の関連エンドポイントを呼び出します。
3. 構造化データを解析して返します。
4. MCP インターフェースを介してツールを AI アシスタントに公開します。

プロジェクト構造

src/
  ├── class/
  │   └── ravelry.class.ts       # 主要な Ravelry クライアントの実装
  ├── endpoints/
  │   ├── getMultiplePatternDetails.ts  # 複数のパターンの詳細情報を取得するインターフェース
  │   ├── getPatternDetails.ts         # 単一のパターンの詳細情報を取得するインターフェース
  │   ├── searchPatterns.ts           # パターンを検索するインターフェース
  │   └── index.ts                    # エンドポイントのエクスポートファイル
  ├── types/
  │   ├── patternDetailed.d.ts       # 詳細なパターンの型定義
  │   └── patternSimple.d.ts         # シンプルなパターンの型定義
  └── index.ts                      # エントリポイントと MCP サーバーの設定

開発情報

環境設定

• .env.development：開発モードで使用します。
• .env.production：本番モードで使用します。

テスト

テストスイートを実行します：

npm test

コードのフォーマットとチェック

# ESLint を実行します
npm run lint

# ESLint のエラーを修正します
npm run lint:fix

# Prettier を使用してコードをフォーマットします
npm run format

デプロイに関する注意事項

1. .env.production ファイルに有効な Ravelry 認証情報が含まれていることを確認します。
2. ビルド時に認証情報がコンパイル後のコードに埋め込まれます。
3. npm run prod を使用してデプロイします。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。詳細は LICENSE ファイルを参照してください。