filesystem

ファイルシステム

mcp-framework で構築された Model Context Protocol（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 Windows：%APPDATA%/Claude/claude_desktop_config.json

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

ビルドとテスト

1. ツールに変更を加えます
2. npm run build を実行してコンパイルします
3. サーバーは起動時にツールを自動的に読み込みます

詳細はこちら

• MCP Framework の GitHub
• MCP Framework のドキュメント