Ravelry

一個連接Ravelry編織API的MCP服務，為AI助手提供編織圖案搜索功能

藝術與文化教育與學習工具 #編織搜索 #圖案查詢 #AI輔助 #手工編織 .TypeScript

評分 : 2分

下載量 : 6

更新時間 : 2025-04-28

什麼是Ravelry MCP 服務器？

Ravelry MCP 服務器是一個基於Model Context Protocol（MCP）的工具，它允許AI助手訪問Ravelry平臺上的編織圖案數據庫。用戶可以通過關鍵詞、過濾條件等快速找到感興趣的編織圖案。

如何使用Ravelry MCP 服務器？

只需啟動服務器並將其集成到您的AI助手設置中，即可開始搜索和獲取編織圖案信息。

適用場景

適合喜歡編織的用戶，尤其是那些希望通過AI助手便捷地發現新項目的人。

主要功能

圖案搜索根據關鍵詞和過濾條件搜索Ravelry平臺上的編織圖案。

獲取圖案詳情查看特定編織圖案的詳細信息，包括材料需求和製作難度。

批量獲取圖案詳情一次性獲取多個編織圖案的詳細信息，方便對比。

優勢與侷限性

優勢

支持多種編織類型（如針織和鉤針）

提供強大的搜索和過濾功能

便於與AI助手集成，提升用戶體驗

侷限性

需要有效的Ravelry API憑據才能運行

某些高級功能可能受限於API權限

如何使用

安裝與配置

克隆倉庫並按照說明安裝依賴項，配置Ravelry API憑據。

啟動服務器

在開發模式下運行服務器以測試其功能。

集成到AI助手

將服務器URL添加到AI助手的MCP設置中。

使用案例

搜索免費的編織帽圖案用戶可以輸入關鍵詞“免費編織帽”來查找合適的項目。

獲取特定圖案詳情用戶可以輸入圖案ID來獲取詳細信息。

常見問題

如何獲取Ravelry API憑據？

是否支持批量搜索？

為什麼我的AI助手無法連接到服務器？

🚀 Ravelry MCP 服務器

該服務器基於模型上下文協議 (MCP) 構建，為 AI 助手提供了與 Ravelry API 交互的工具，能讓其搜索、探索並獲取編織圖案，極大地提升了編織圖案數據的獲取效率。

🚀 快速開始

此服務器採用 TypeScript 和 Node.js 構建，支持 AI 助手藉助 Model Context Protocol (MCP) 與 Ravelry API 進行交互。其核心功能有搜索編織圖案、獲取詳細信息，並且支持多模式查詢。

開發模式

npm run dev

生產模式

npm start

✨ 主要特性

搜索圖案：可依據關鍵字搜索編織圖案。
獲取詳細信息：能檢索特定圖案的詳細內容。
批量查詢：一次可獲取多個圖案的詳細信息。
過濾功能：支持按工藝類型（如編織或鉤針）和價格進行篩選。

📦 安裝指南

先決條件

安裝 Node.js 和 npm（推薦使用版本 14 或更高）。
安裝 TypeScript 和其他項目依賴項。
配置 Ravelry API 憑證。

安裝步驟

克隆倉庫：

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

安裝依賴項：
```
npm install
```
配置環境變量。

💻 使用示例

基礎用法

將服務器作為 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 數組（必填）

📚 詳細文檔

集成指南

將服務器作為 MCP 工具集成到 AI 系統中，通過上述接口調用相應功能。

工作原理

使用 Basic Auth 鑑權訪問 Ravelry API。
調用 Ravelry API 的相關端點。
解析並返回結構化數據。
通過 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

部署注意事項

確保 .env.production 文件包含有效的 Ravelry 憑證。
構建時會將憑據嵌入到編譯後的代碼中。
使用 npm run prod 進行部署。

🔧 技術細節

該服務器使用 TypeScript 和 Node.js 構建，通過 Model Context Protocol (MCP) 與 Ravelry API 進行交互。在實現過程中，利用 Basic Auth 鑑權訪問 Ravelry API 的相關端點，解析返回的數據並以結構化形式呈現。同時，通過 MCP 接口將工具暴露給 AI 助手，實現搜索、獲取詳細信息等功能。