Boilerplate MCP Server

🚀 管理样板 Model Context Protocol (MCP) サーバー実装（TypeScriptを使用）

このプロジェクトは、TypeScriptを用いたModel Context Protocol (MCP) サーバーの実装を提供します。パッケージのインストール、サーバーの設定、クライアントの使用方法などを含む詳細なガイドが用意されています。

🚀 クイックスタート

このセクションでは、@aashari/boilerplate-mcp-server パッケージの基本的な使い方を紹介します。

📦 インストール

以下のコマンドを使用して、このパッケージをインストールします。

npm install -y @aashari/boilerplate-mcp-server

💻 使用例

基本的な使用法

新しいMCPサービスの作成

1. 新しいプロジェクトを初期化します。

npx tsx init

2. src/index.ts ファイルに以下の内容を追加します。

import { createServer } from '@aashari/boilerplate-mcp-server';

const server = createServer();

// カスタム機能を追加
server.getIpDetails.addHandler((context) => {
  return {
    status: 'success',
    country: '中国',
    countryCode: 'CN',
    region: 'BJ',
    regionName: '北京',
    city: '北京',
    zip: '100000',
    lat: '39.9045',
    lon: '116.4074',
    timezone: 'Asia/Shanghai',
    isp: '中国移动',
    org: 'China Mobile',
    as: 'AS9009 中国互联网有限公司',
    query: context.ip,
  };
});

server.listen(3000);

3. サービスを起動します。

npm run dev

MCPクライアントの使用

import { createClient } from '@aashari/boilerplate-mcp-server';

const client = createClient('http://localhost:3000');

// 現在のデバイスのIP詳細情報を取得
client.getIpDetails().then(console.log);

// 指定したIPの詳細情報を取得
client.getIpDetails('8.8.8.8').then(console.log);

高度な使用法

コマンドラインツール（CLI）の使用

コマンドラインツールを直接使用することができます。

• ヘルプと利用可能なコマンドを表示します。

npx -y @aashari/boilerplate-mcp-server --help

例としての出力は以下の通りです。

使用：@aashari/boilerplate-mcp-server [オプション] [コマンド]

TypeScriptを使用したモデルコンテキストプロトコル（MCP）サーバーの基本的なボイラープレート

オプション：
  -V, --version               バージョン番号を出力
  -h, --help                  コマンドのヘルプを表示

コマンド：
  get-ip-details [ipAddress]   特定のIPアドレスまたは現在のデバイスの詳細情報を取得
  help [command]              コマンドのヘルプを表示

• 現在のデバイスのIP詳細情報を取得します。

npx -y @aashari/boilerplate-mcp-server get-ip-details

例としての出力は以下の通りです。

状態: 成功
国: インドネシア
国コード: ID
地域: JK
地域名: ジャカルタ
都市: ジャカルタ
郵便番号: 11730
緯度: -6.2114
経度: 106.8446
タイムゾーン: Asia/Jakarta
ISP: Biznet Wifi
組織:
AS: AS17451 BIZNET NETWORKS
クエリ: 118.923.134.234

• 指定したIPの詳細情報を取得します。

npx -y @aashari/boilerplate-mcp-server get-ip-details 8.8.8.8

📚 ドキュメント

設定

環境変数

以下の環境変数を設定することで、サーバーを構成することができます。

• PORT: サービスがリッスンするポートを設定します（デフォルト値: 3000）

PORT=8080 npm run dev

開発者ガイド

MCPサービスのカスタマイズ

createServer 関数を拡張することで、MCPサービスをカスタマイズすることができます。 例えば、カスタムハンドラーを追加するには、以下のようにします。

import { createServer } from '@aashari/boilerplate-mcp-server';

const server = createServer();

server.getIpDetails.addHandler((context) => {
  return {
    status: 'success',
    country: '中国',
    countryCode: 'CN',
    region: 'BJ',
    regionName: '北京',
    city: '北京',
    zip: '100000',
    lat: '39.9045',
    lon: '116.4074',
    timezone: 'Asia/Shanghai',
    isp: '中国移动',
    org: 'China Mobile',
    as: 'AS9009 中国互联网有限公司',
    query: context.ip,
  };
});

server.listen(3000);

プロジェクト情報

依存関係のインストール

すべての依存関係をインストールするには、以下のコマンドを実行します。

npm install

コマンドラインの例

パッケージのインストール

npm install -y @aashari/boilerplate-mcp-server

サービスの実行

npx tsx init && npm run dev

クライアントの使用

import { createClient } from '@aashari/boilerplate-mcp-server';

const client = createClient('http://localhost:3000');

// 現在のデバイスのIP詳細情報を取得
client.getIpDetails().then(console.log);

// 指定したIPの詳細情報を取得
client.getIpDetails('8.8.8.8').then(console.log);

コマンドラインツールの使用

npx -y @aashari/boilerplate-mcp-server get-ip-details 8.8.8.8

その他のリソース

• プロジェクトドキュメント
• 問題追跡

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。

Copyright (c) 2023, aashari.

以下の条件に従うことを条件として、無償で、このソフトウェアおよび関連するドキュメントファイル（「ソフトウェア」）のコピーを取得するすべての人に、制限なくソフトウェアを取り扱う権利が与えられます。これには、使用、コピー、変更、マージ、公開、配布、サブライセンス、および/またはソフトウェアのコピーを販売する権利が含まれ、ソフトウェアが提供される人に同じことを許可することも含まれます。

上記の著作権表示およびこの許諾表示は、ソフトウェアのすべてのコピーまたは実質的な部分に含まれるものとします。

ソフトウェアは「現状のまま」提供され、明示的または黙示的ないかなる保証も伴いません。これには、商品性、特定の目的への適合性、および非侵害の保証が含まれますが、これらに限定されません。いかなる場合も、著者または著作権者は、契約、不法行為、またはその他の方法による、ソフトウェアまたはソフトウェアの使用またはその他の取り扱いに関連するいかなる請求、損害、またはその他の責任についても、責任を負いません。