Semantic Search MCP Server

🚀 語義搜索 MCP 服務器

語義搜索 MCP 服務器是一個基於 mcp - framework 構建的 Model Context Protocol (MCP) 服務器，它能夠顯著增強 Claude Desktop 的語義搜索功能，為用戶提供更精準、高效的搜索體驗。

🚀 快速開始

# 安裝依賴項
npm install

# 構建項目
npm run build

✨ 主要特性

• 基於 mcp - framework 構建，為 Claude Desktop 提供語義搜索功能增強。
• 提供詳細的用戶指南和開發者指南，方便不同用戶群體使用和擴展。
• 支持通過 CLI 添加工具，便於開發人員擴展服務器功能。

📚 詳細文檔

有關詳細設置說明和使用方法：

• 用戶指南 - 分步安裝說明，適用於Claude Desktop 用戶。
• 開發者指南 - 技術信息，供開發人員參考或擴展服務器使用。

📦 安裝指南

本地開發

在你的 Claude Desktop 配置文件中添加以下內容：

• MacOS: ~/Library/Application Support/Claude/Settings.json
• Windows: %APPDATA%/Claude/Settings.json

{
  "semantic-search-mcp-server": {
    "path": "relative/path/to/src",
    "enable": true
  }
}

發佈後使用

將服務器發佈到 npm 後，用戶可以在其 Claude Desktop 中安裝並使用它：

claire install semantic-search-mcp-server

💻 使用示例

基礎用法

# 安裝依賴項
npm install

# 構建項目
npm run build

高級用法

添加組件

項目附帶了一個示例工具在 src/tools/ExampleTool.ts。你可以使用 CLI 添加更多工具：

# 添加一個新的工具
mcp add tool my-tool

# 例如，你可以創建以下工具：
mcp add tool data-processor
mcp add tool api-client
mcp add tool file-handler

工具開發

示例工具結構：

import { MCPTool } from "mcp-framework";
import { z } from "zod";

interface MyToolInput {
  message: string;
}

class MyTool extends MCPTool<MyToolInput> {
  name = "my_tool";
  description = "描述你的工具的功能";

  schema = {
    message: {
      type: z.string(),
      description: "這個輸入參數的說明",
    },
  };

  async execute(input: MyToolInput) {
    // 在此處編寫你的工具邏輯
    return `Processed: ${input.message}`;
  }
}

export default MyTool;

🔧 技術細節

項目結構

semantic-search-mcp-server/
├── src/
│   ├── tools/        # MCP 工具目錄
│   │   └── ExampleTool.ts
│   └── index.ts      # 服務器入口文件
├── Userguide.md      # 安裝指南，適用於Claude Desktop 用戶
├── DeveloperGuide.md # 技術指南，供開發人員參考
├── package.json
└── tsconfig.json

發佈到 npm

1. 更新 package.json：
   • 確保 name 唯一且符合 npm 命名規範。
   • 設置適當的 version。
   • 添加 description、author、license 等信息。
   • 檢查 bin 是否指向正確的入口文件。
2. 本地構建和測試：

   npm run build
   npm link
   semantic-search-mcp-server  # 在本地測試你的 CLI
   

3. 登錄到 npm（如果需要，創建賬戶）：

   npm login
   

4. 發佈你的包：

   npm publish
   

構建和測試

npm run build
npm test

通過以上步驟，你可以輕鬆地構建、開發和部署一個功能強大的語義搜索 MCP 服務器，並與 Claude Desktop 集成使用。希望這個指南能幫助你順利完成開發！