Semantic Search MCP Server

🚀 Semantic Search MCP Server

A Model Context Protocol (MCP) server built with the mcp-framework to enhance the semantic search functionality of Claude Desktop.

🚀 Quick Start

# Install dependencies
npm install

# Build the project
npm run build

📚 Documentation

For detailed setup instructions and usage methods:

• User Guide - Step-by-step installation instructions for Claude Desktop users.
• Developer Guide - Technical information for developers to refer to or extend the server.

📦 Project Structure

semantic-search-mcp-server/
├── src/
│   ├── tools/        # MCP tool directory
│   │   └── ExampleTool.ts
│   └── index.ts      # Server entry file
├── Userguide.md      # Installation guide for Claude Desktop users
├── DeveloperGuide.md # Technical guide for developers
├── package.json
└── tsconfig.json

🔧 For Developers

The following section contains technical information for those who wish to modify or extend the server.

Adding Components

The project comes with an example tool at src/tools/ExampleTool.ts. You can use the CLI to add more tools:

# Add a new tool
mcp add tool my-tool

# For example, you can create the following tools:
mcp add tool data-processor
mcp add tool api-client
mcp add tool file-handler

💻 Tool Development

Basic Usage

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

interface MyToolInput {
  message: string;
}

class MyTool extends MCPTool<MyToolInput> {
  name = "my_tool";
  description = "Describe the functionality of your tool";

  schema = {
    message: {
      type: z.string(),
      description: "Explanation of this input parameter",
    },
  };

  async execute(input: MyToolInput) {
    // Write your tool logic here
    return `Processed: ${input.message}`;
  }
}

export default MyTool;

📤 Publishing to npm

1. Update package.json:

   • Ensure that the name is unique and complies with npm naming conventions.
   • Set an appropriate version.
   • Add description, author, license, and other information.
   • Check that bin points to the correct entry file.

2. Build and test locally:

   npm run build
   npm link
   semantic-search-mcp-server  # Test your CLI locally
   

3. Log in to npm (create an account if necessary):

   npm login
   

4. Publish your package:

   npm publish
   

After publishing, users can add it to their Claude Desktop client (read the instructions below) or run it via npx.

🛠️ Using with Claude Desktop

Local Development

Add the following content to your Claude Desktop configuration file:

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

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

After Publishing

After publishing the server to npm, users can install and use it in their Claude Desktop:

claire install semantic-search-mcp-server

🔨 Building and Testing

npm run build
npm test

Through the above steps, you can easily build, develop, and deploy a powerful semantic search MCP server and integrate it with Claude Desktop. We hope this guide helps you complete your development smoothly!