Poc MCP Server

🚀 POC MCP 服務器

本項目是一個模型上下文協議 (MCP) 服務器的概念驗證實現，提供了一系列工具，可用於訪問和操作有關 Loomers、表單、表單響應和項目的信息。

🚀 快速開始

本項目是一個模型上下文協議 (MCP) 服務器的概念驗證實現，可用於訪問和操作有關 Loomers、表單、表單響應和項目的信息。以下是項目啟動的基本步驟：

1. 確保你的環境滿足項目需求。
2. 按照安裝步驟完成項目的依賴安裝。
3. 根據需要選擇開發、構建、運行、測試或代碼檢查等操作。

✨ 主要特性

• 數據獲取：可獲取 Loomers 及特定區域內的 Loomers、表單、表單響應和項目。
• 分頁支持：所有列表操作均支持分頁功能。
• 過濾與排序：具備過濾和排序功能，方便數據篩選和整理。

📦 安裝指南

環境需求

• Node.js 18 或更高版本
• pnpm 10 或更高版本

安裝命令

pnpm install

💻 使用示例

基礎用法

以下是項目開發、構建、運行、測試和代碼檢查的基本命令：

啟動開發服務器

pnpm dev

構建項目

pnpm build

運行已構建的項目

pnpm start

運行測試

pnpm test

運行代碼檢查工具

pnpm lint

高級用法

項目提供了多個工具函數，以下是部分工具函數的使用說明：

getLoomers

獲取 Loomers 列表，支持可選的分頁、過濾和排序。

// 示例代碼，具體使用根據項目實際情況
const loomers = getLoomers({ page: 1, limit: 10, filter: { key: 'value' }, sort: 'asc' });

getLoomersInArea

在特定區域內獲取 Loomers 列表。

// 示例代碼，具體使用根據項目實際情況
const loomersInArea = getLoomersInArea({ area: 'specific_area' });

getForms

獲取表單列表，支持可選的分頁、過濾和排序。

// 示例代碼，具體使用根據項目實際情況
const forms = getForms({ page: 1, limit: 10, filter: { key: 'value' }, sort: 'asc' });

getFormResponses

獲取表單響應列表，支持可選的分頁、過濾和排序。

// 示例代碼，具體使用根據項目實際情況
const formResponses = getFormResponses({ page: 1, limit: 10, filter: { key: 'value' }, sort: 'asc' });

getProjects

獲取項目列表，支持可選的分頁、過濾和排序。

// 示例代碼，具體使用根據項目實際情況
const projects = getProjects({ page: 1, limit: 10, filter: { key: 'value' }, sort: 'asc' });

📚 詳細文檔

項目結構

src/
  ├── config/       # 配置文件
  ├── tools/        # MCP 工具實現
  │   └── __tests__ # 工具測試
  ├── types/        # TypeScript 類型定義
  └── index.ts      # 主入口點

工具說明

getLoomers

• 功能：獲取 Loomers 列表，支持可選的分頁、過濾和排序。
• 參數：
  • page：頁碼，可選。
  • limit：每頁數量，可選。
  • filter：過濾條件，可選。
  • sort：排序方式，可選。

getLoomersInArea

• 功能：在特定區域內獲取 Loomers 列表。
• 參數：
  • area：特定區域，必填。

getForms

• 功能：獲取表單列表，支持可選的分頁、過濾和排序。
• 參數：
  • page：頁碼，可選。
  • limit：每頁數量，可選。
  • filter：過濾條件，可選。
  • sort：排序方式，可選。

getFormResponses

• 功能：獲取表單響應列表，支持可選的分頁、過濾和排序。
• 參數：
  • page：頁碼，可選。
  • limit：每頁數量，可選。
  • filter：過濾條件，可選。
  • sort：排序方式，可選。

getProjects

• 功能：獲取項目列表，支持可選的分頁、過濾和排序。
• 參數：
  • page：頁碼，可選。
  • limit：每頁數量，可選。
  • filter：過濾條件，可選。
  • sort：排序方式，可選。