mcp-framework-スターター
mcp-framework を使用して構築されたモデル コンテキスト プロトコル (MCP) サーバー。
クイックスタート
# Install dependencies
npm install
# Build the project
npm run build
プロジェクト構造
mcp-framework-starter/
├── 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への公開
- package.json を更新します。
nameが一意であり、npm の命名規則に従っていることを確認してください。- 適切な
versionを設定する description 、 author 、 licenseなどを追加します。binが正しいエントリファイルを指しているか確認する
- ローカルでビルドしてテストします。
npm run build
npm link
mcp-framework-starter # Test your CLI locally
- npm にログインします (必要に応じてアカウントを作成します)。
- パッケージを公開します:
公開後、ユーザーはそれをクロードデスクトップクライアント（下記参照）に追加したり、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": {
"mcp-framework-starter": {
"command": "node",
"args":["/absolute/path/to/mcp-framework-starter/dist/index.js"]
}
}
}
公開後
この構成を Claude Desktop 構成ファイルに追加します。
MacOS : ~/Library/Application Support/Claude/claude_desktop_config.json Windows : %APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"mcp-framework-starter": {
"command": "npx",
"args": ["mcp-framework-starter"]
}
}
}
構築とテスト
- ツールに変更を加える
npm run buildを実行してコンパイルする- サーバーは起動時にツールを自動的に読み込みます
もっと詳しく知る