MCP Server Typescript

🚀 TypeScript SDK 使用説明

このSDKは、MCP（Model Context Protocol）のTypeScript用の開発キットです。開発者はこのSDKを使用して、MCPサーバーを簡単に構築することができます。

🚀 クイックスタート

以下は、SDKを使った簡単なサンプルです。これを参考に、すぐに始めることができます。

import { Server } from "@modelcontextprotocol/typescript-sdk";
import { StdioServerTransport } from "@modelcontextprotocol/typescript-sdk";

const server = new Server({
  name: "example-server",
  version: "1.0.0"
});

server.setRequestHandler("ping", () => {
  return {
    status: "pong"
  };
});

const transport = new StdioServerTransport();
await server.connect(transport);

✨ 主な機能

• 簡単なサーバーの設定が可能で、setRequestHandler メソッドを使ってリクエストハンドラーを設定できます。
• 複数のトランスポート方式（StdioServerTransport、RawServerTransport など）に対応しています。
• TypeScriptの型定義をサポートしており、開発者が型安全に開発できます。

📦 インストール

MCP TypeScript SDKをインストールするには、以下の手順に従ってください。

npmを使用したインストール

npm install @modelcontextprotocol/typescript-sdk

その他のプラットフォーム

Yarnやpnpmなどの他のパッケージ管理ツールを使用する場合は、それぞれのドキュメントを参照してください。

💻 使用例

基本的な使用法

以下は、基本的なMCPサーバーの実装例です。

import { Server } from "@modelcontextprotocol/typescript-sdk";
import { StdioServerTransport } from "@modelcontextprotocol/typescript-sdk";

const server = new Server({
  name: "example-server",
  version: "1.0.0"
});

server.setRequestHandler("ping", () => {
  return {
    status: "pong"
  };
});

const transport = new StdioServerTransport();
await server.connect(transport);

高度な使用法

データベース統合の例

以下は、SQLiteデータベースを統合したより複雑なMCPサーバーの実装例です。

import { Server } from "@modelcontextprotocol/typescript-sdk";
import sqlite3 from "sqlite3";
import { promisify } from "util";
import { z } from "zod";

const server = new Server({
  name: "SQLite Explorer",
  version: "1.0.0"
});

const getDb = () => {
  const db = new sqlite3.Database("database.db");
  return {
    all: promisify(db.all.bind(db)),
    close: promisify(db.close.bind(db))
  };
};

server.setRequestHandler("schema", async () => {
  const db = getDb();
  try {
    const tables = await db.all(
      "SELECT sql FROM sqlite_master WHERE type='table'"
    );
    return {
      contents: [{
        uri: "schema://main",
        text: tables.map((t: {sql: string}) => t.sql).join("\n")
      }]
    };
  } finally {
    await db.close();
  }
});

server.setRequestHandler("query", async ({ body }) => {
  const sql = body.text;
  const db = getDb();
  try {
    const results = await db.all(sql);
    return {
      content: [{
        type: "text",
        text: JSON.stringify(results, null, 2)
      }]
    };
  } catch (err: unknown) {
    const error = err as Error;
    return {
      content: [{
        type: "text",
        text: `Error: ${error.message}`
      }],
      status: "error"
    };
  } finally {
    await db.close();
  }
});

const transport = new StdioServerTransport();
await server.connect(transport);

低レベル実装の例

以下は、低レベルの実装例です。

import { Server } from "@modelcontextprotocol/typescript-sdk";
import { RawServerTransport } from "@modelcontextprotocol/typescript-sdk";

const server = new Server({
  name: "example-server",
  version: "1.0.0"
});

server.setRequestHandler("ping", () => {
  return {
    status: "pong"
  };
});

const transport = new RawServerTransport();
await server.connect(transport);

TypeScript型定義の例

以下は、カスタム型定義の例です。

import { Server } from "@modelcontextprotocol/typescript-sdk";
import { z } from "zod";

type User = {
  id: string;
  name: string;
  email: string;
};

const userSchema = z.object({
  id: z.string().min(1),
  name: z.string().min(1),
  email: z.string().email()
});

const server = new Server({
  name: "example-server",
  version: "1.0.0"
});

server.setRequestHandler("user", async ({ body }) => {
  const user = await body.validate(userSchema);
  return {
    user
  };
});

📚 ドキュメント

詳細な情報については、以下のリンクを参照してください。

• 公式ドキュメント
• GitHubリポジトリ

📄 ライセンス

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

MIT License

Copyright (c) 2023 Example Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.