Sbb MCP Server

🚀 MCP TypeScript プロジェクトガイド

MCP TypeScript は、効率的なサーバーサイドアプリケーションを構築するためのフレームワークです。ツール、リソース、プロンプトテンプレートなど、様々な機能モジュールをサポートしています。以下では、このフレームワークを使ってこれらの機能を実現する方法や、関連する設定とベストプラクティスについて詳しく説明します。

🚀 クイックスタート

核心コンポーネント

1. ツール（Tools）
   • データ処理や API 呼び出しなど、特定のタスクを実行するために使用されます。
2. リソース（Resources）
   • URI でアクセス可能なリソースインターフェースを提供します。
3. プロンプトテンプレート（Prompt Templates）
   • ユーザー入力を会話メッセージに変換する方法を定義します。

実装例

ツールの例：Echo Tool

server.tool("echo", { message: z.string() }, async ({ message }) => ({
  content: [{ type: "text", text: `Tool echo: ${message}` }],
}));

リソースの例：Echo Resource

server.resource(
  "echo",
  new ResourceTemplate("echo://{message}", { list: undefined }),
  async (uri, { message }) => ({
    contents: [
      {
        uri: uri.href,
        text: `Resource echo: ${message}`,
      },
    ],
  })
);

プロンプトテンプレートの例：Echo Prompt

server.prompt("echo", { message: z.string() }, ({ message }) => ({
  messages: [
    {
      role: "user",
      content: {
        type: "text",
        text: `Please process this message: ${message}`,
      },
    },
  ],
}));

✨ 主な機能

プロジェクト構造

• src/index.ts：メインサーバーの実装ファイルです。
• src/low - level - index.ts：低レベル API を使用した代替実装です。
• dist/：コンパイル出力ディレクトリです。

設定とデプロイ

環境変数の設定

1. Docker Compose の使用

   # docker-compose.yaml
   services:
     mmcp-server:
       environment:
         - API_KEY=${API_KEY}
         - DATABASE_URL=${DATABASE_URL}
   

2. コード内でのアクセス

   const apiKey = process.env.API_KEY;
   const dbUrl = process.env.DATABASE_URL;
   

3. ローカル開発

   • .env ファイルを作成します：

     API_KEY=sk - 123
     

   • .env を .gitignore に追加します。

4. 本番環境でのデプロイ

   • デプロイプラットフォームで環境変数を設定します。
   • 機密情報をバージョン管理にコミットしないようにします。

セキュリティに関する注意事項

• 開発環境と本番環境で異なる環境変数セットを使用します。
• 機密情報がクライアントに公開されないようにします。

ベストプラクティス

1. エラー処理

   • 包括的なエラー処理メカニズムを実装します。
   • 意味のあるエラーメッセージを提供します。

2. 型安全

   • TypeScript を使用して環境変数の型を定義します。
   • zod を使用して実行時の検証を行います。

3. ログ記録

   • server.server.sendLoggingMessage を使用してデバッグ情報を送信します：

     server.server.sendLoggingMessage({
       level: "info",
       data: "Starting server...",
     });
     

プロジェクトのデプロイ

Docker でのデプロイ例

docker build -t mcp - typescript .
docker run -p 3000:3000 --env API_KEY=your_key mcp - typescript

エンドポイントのテスト

curl または Postman を使用してサービスエンドポイントをテストします：

curl http://localhost:3000/echo?message=test

📄 ライセンス

• ライセンス：MIT License
• メンテナー：MCP 開発チーム

💡 貢献ガイド

コミュニティからの貢献を歓迎します！詳細は [CONTRIBUTING.md](https://github.com/mcptype/mcp - typescript/blob/main/CONTRIBUTING.md) を参照してください。

🐞 問題の報告

問題が発生した場合は、[GitHub Issues](https://github.com/mcptype/mcp - typescript/issues) に報告してください。

以上が MCP TypeScript フレームワークの詳細ガイドで、設定からデプロイまでの全プロセスをカバーしています。効率的なサーバーサイドアプリケーションの構築に役立てていただければ幸いです。