AI导哈

MCP服务器框架

一个基于mcp-framework构建的模型上下文协议服务器，用于开发和管理自定义工具，支持本地开发和npm发布。

  • by QuantGeekDev
  • TypeScript
  • 本地部署
  • 5 星标
  • 更新于
在 GitHub 查看 QuantGeekDev/mcp-filesystem

使用说明

文件系统

使用MCP框架构建的模型上下文协议（MCP）服务器。

快速开始

# Install dependencies
npm install

# Build the project
npm run build

项目结构

filesystem/
├── src/
│   ├── tools/        # MCP Tools
│   │   └── ExampleTool.ts
│   └── index.ts      # Server entry point
├── package.json
└── tsconfig.json

添加组件

该项目附带了一个示例工具 src/tools/ExampleTool.ts。您可以使用CLI添加更多工具：

# Add a new tool
mcp add tool my-tool

# Example tools you might create:
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 = "Describes what your tool does";

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

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

export default MyTool;

发布到npm

  1. 更新你的package.json：

    • 确保 name 是唯一的，遵循npm命名约定
    • 设置适当 version
    • 添加 description, author, license等等。
    • 检查 bin 指向正确的条目文件

  2. 在本地构建和测试：

    npm run build
npm link
filesystem  # Test your CLI locally

  3. 登录npm（必要时创建帐户）：

    npm login

  4. 发布您的包：

    npm publish

发布后，用户可以将其添加到他们的claude桌面客户端（见下文）或使用npx运行它


## Using with Claude Desktop

### Local Development

Add this configuration to your Claude Desktop config file:

**MacOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
**Windows**: `%APPDATA%/Claude/claude_desktop_config.json`

```json
{
  "mcpServers": {
    "filesystem": {
      "command": "node",
      "args":["/absolute/path/to/filesystem/dist/index.js"]
    }
  }
}

发布后

将此配置添加到您的Claude Desktop配置文件中：

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json 视窗: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "filesystem": {
      "command": "npx",
      "args": ["filesystem"]
    }
  }
}

建造和测试

  1. 对工具进行更改
  2. 跑 npm run build 编写
  3. 服务器将在启动时自动加载您的工具

了解更多

相关 MCP