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 集成使用。希望这个指南能帮助你顺利完成开发！