关于 MCP Server Boilerplate
MCP Server Boilerplate 为开发者提供构建自定义 MCP 服务的基础实现。不同分支依次演示数字翻倍、获取虚拟文本和显示环境变量。
主要功能
- 01MCP 服务基础实现
- 02在 src/index.ts 添加自定义工具
- 03数字翻倍工具
- 04获取虚拟文本工具
- 05显示环境变量示例
适用场景
- 01作为自定义 MCP 服务的起点
- 02学习定义和扩展服务工具
MCP 相关
该项目实现 MCP 服务,向客户端提供数字翻倍和获取虚拟文本等工具,并可显示配置的环境变量。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。
详细介绍
来自项目 READMEMCP Server Boilerplate
Model Context Protocol(MCP) サーバーのボイラープレートとなるシンプルな実装です。
概要
このプロジェクトは、Model Context Protocol (MCP) サーバーの基本的な実装です。このボイラープレートを使用することで、独自のMCPサーバーを素早く構築し、カスタムツールを実装できます。
簡易な自作MCPサーバーをお試しで実装する方法 - Zenn の記事をベースに、実用的な補足や補助ツールを加えることで、MCPサーバーの構築と拡張方法をより分かりやすく示しています。
v1 ブランチ
数値を2倍にする単純なツール。MCPサーバーの構築方法と、カスタムツールの実装方法を示す最小限のリファレンス実装です。
v2 ブランチ
v1 ブランチに、ダミーサーバーから文字列データを取得するツールを追加したものです。
v3 ブランチ
v2 ブランチに、環境変数の値を取得して表示する機能を追加したものです。MCP設定ファイルに環境変数を設定する必要があります。
前提条件
- Node.js (v23.11.0以上)
- npm または yarn
対応MCPクライアント
- Claude Code
- VSCode
- Windsurf
- Cursor
- AWS Bedrock (未確認)
インストール方法
# リポジトリのクローン
git clone [リポジトリURL]
cd mcp-server-boilerplate
# 依存パッケージのインストール
npm install
# ビルド
npm run build
使用方法
MCPクライアントのMCP設定ファイルに、以下の設定を追加してください。
絶対パスで指定してください。
(※ホームディレクトリに ~ は使用できません。)
{
"mcpServers": {
"mcp-server-boilerplate": {
"command": "node",
"args": [
"/absolute/path/to/mcp-server-boilerplate/build/index.js"
],
"env": {
"FOO": "BAR"
}
}
}
}
以下のコマンドでダミーサーバーを起動してください。ダミーサーバーは、ダミーの文字列データを提供するだけのものです。 (ポート番号は任意で、3000番を既に使用している場合は、別のポート番号を指定してください。)
npx serve dummy-server
設定の変更を適用するために、MCPクライアントを再起動してください。 エージェントモードで各ツールのプロンプト例にあるプロンプトを実行して、ツールが正しく動作するか確認してください。(ツール名の指定は必須ではないが、確実にツールを使用させるために指定しています。)
提供するツール
double_number
与えられた数値を2倍にします。
パラメータ
num(number): 2倍にする数値
戻り値
- 入力された数値の2倍の値
プロンプト例
double_number を使って3を2倍した結果を表示して
get_test_text
ダミーサーバーから文字列データを取得します。
設定ファイルの環境変数FOOの値も表示します。
パラメータ
- なし
戻り値
- 取得した文字列データ
プロンプト例
テスト用の文字列データを取得して、内容の説明をして
開発方法
プロジェクト構造
mcp-server-boilerplate/
├── .vscode/ # VSCode設定
├── dummy-server/ # ダミーサーバー
├── build/ # ビルド出力先
├── node_modules/ # 依存パッケージ
├── src/ # ソースコード
│ ├── index.ts # エントリーポイント
│ └── {types}/ # 型定義(追加予定)
├── {tests/} # テスト
├── .env # 環境変数
├── {.env.example} # 環境変数の例
├── .gitignore # Gitの除外設定
├── .windsurfrules # Windsurf設定
├── biome.json # Biome設定
├── package.json # 依存関係と設定
├── README.md # READMEファイル
└── tsconfig.json # TypeScript設定
新しいツールの追加方法
src/index.ts ファイルを編集し、以下のパターンに従ってツールを追加します:
/**
* ツールの定義
* nameとdescriptionを元に、実行するtoolが選択される
* handlerはCallToolResult(非同期の場合はそのPromise)を返す
* @param name - ツールの名前
* @param description - ツールの説明
* @param args - ツールの引数の定義
* @param handler - ツールの実装
*/
server.tool(
"ツールの名前",
"ツールの説明",
{パラメータ名: z.型().describe("パラメータの説明")},
({パラメータ名}) => ({content: [{type: "text", text: 結果}]}),
);
主な依存パッケージ
@modelcontextprotocol/sdk: ^1.9.0 - MCPサーバーの実装に必要なSDKzod: ^3.24.2 - 型検証とスキーマ定義のためのライブラリ
開発ツール
Biome
Biomeは、JavaScriptとTypeScriptのための高速なリンター兼フォーマッターです。このプロジェクトでは、コードの品質と一貫性を保つために使用しています。
biome.jsonファイルに、プロジェクト固有のルールと設定が定義されています。
以下のnpmスクリプトが利用可能です:
# コードをチェック
npm run lint
# コードをチェックして問題を自動修正
npm run lint:fix
# フォーマットをチェック
npm run format
# フォーマットを自動修正
npm run format:fix
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。