filesystem

一个使用 mcp-framework 构建的 Model Context Protocol (MCP) 服务器。

快速开始

# 安装依赖
npm install

# 构建项目
npm run build

项目结构

filesystem/
├── src/
│   ├── tools/        # MCP 工具
│   │   └── ExampleTool.ts
│   └── index.ts      # 服务器入口点
├── package.json
└── tsconfig.json

添加组件

该项目自带一个示例工具，位于 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;

发布到 npm

1. 更新您的 package.json：

   • 确保 name 是唯一的，并遵循 npm 命名约定
   • 设置合适的 version
   • 添加 description、author、license 等
   • 检查 bin 指向正确的入口文件

2. 在本地构建和测试：

   npm run build
   npm link
   filesystem  # 在本地测试您的 CLI
   

3. 登录到 npm（如果需要，创建帐户）：

   npm login
   

4. 发布您的包：

   npm publish
   

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

## 与 Claude Desktop 一起使用

### 本地开发

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

**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 Windows: %APPDATA%/Claude/claude_desktop_config.json

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

构建和测试

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

了解更多

• MCP Framework Github
• MCP Framework 文档