Litemcp

🚀 LiteMCP 日本語ドキュメント

このプロジェクトは、MCP（モデルコンテキストプロトコル）サーバーをエレガントに構築するための TypeScript フレームワークです。

⚠️ 重要提示

公式の SDK がこのプロジェクトと同様の高レベル API を提供するようになったため、このプロジェクトはもう維持されません。

もしこのプロジェクトの CLI コマンドが好きなら、独立して使用してください：https://github.com/wong2/mcp-cli

✨ 主な機能

• シンプルなツール、リソース、プロンプトの定義
• 完全な TypeScript サポート
• 組み込みの ログ記録
• 組み込みのエラー処理
• テストとデバッグ用の組み込み CLI テストとデバッグ
• SSE トランスポート の組み込みサポート

📦 インストール

npm install litemcp zod

🚀 クイックスタート

import { LiteMCP } from "litemcp";
import { z } from "zod";

const server = new LiteMCP("demo", "1.0.0");

server.addTool({
  name: "add",
  description: "添加两个数字",
  parameters: z.object({
    a: z.number(),
    b: z.number(),
  }),
  execute: async (args) => {
    return args.a + args.b;
  },
});

server.addResource({
  name: "resource-example",
  description: "这是一个示例资源",
  content: "Hello, World!",
});

server.start();

以下のコマンドを実行してサーバーをテストします：

node server.js

📚 ドキュメント

ツール（Tools）

ツールは、実行可能な操作を定義する関数です。例えば、シンプルな電卓ツールです。

server.addTool({
  name: "calculator",
  description: "A simple calculator",
  parameters: z.object({
    a: z.number(),
    b: z.number(),
  }),
  async execute(args) {
    return { 
      add: args.a + args.b,
      subtract: args.a - args.b
    };
  },
});

リソース（Resources）

リソースは、アクセス可能な静的コンテンツまたは動的に生成されるコンテンツを表します。

server.addResource({
  name: "static-resource",
  description: "A static resource example",
  content: "This is a static resource.",
});

server.addDynamicResource(async () => {
  return {
    name: "dynamic-resource",
    description: "A dynamic resource example",
    content: await fetch('https://api.example.com/data'),
  };
});

プロンプト（Prompts）

プロンプトは、対話型の会話フローを定義するために使用されます。

server.addPrompt({
  name: "greeting-prompt",
  description: "A simple greeting prompt",
  async execute() {
    const name = await server.prompt("请输入你的名字：");
    return `你好，${name}！`;
  },
});

ログ記録（Logging）

LiteMCP は組み込みのログ記録機能を提供します。

server.log("信息日志");
server.debug("调试日志");
server.error("错误日志");

サーバーの起動

サーバーを起動する

デフォルトでは、サーバーは stdio トランスポートを使用します：

server.start();

カスタムポートやその他のオプションを指定することもできます：

server.start({
  port: 3000,
  hostname: 'localhost',
});

デバッグとログ記録

以下のコマンドでデバッグを行うことができます：

node server.js --inspect

同時に、LiteMCP は組み込みのデバッグ機能を提供します：

server.debug("调试信息");

SSE トランスポート

サーバーはデフォルトで stdio トランスポートで動作します。SSE モードを使用することもできます：

server.start({
  transportType: "sse",
  sse: {
    endpoint: "/sse",
    port: 8080,
  },
});

これにより、サーバーが起動し、http://localhost:8080/sse で SSE 接続を待ち受けます。

展示

もしあなたが LiteMCP を使ってサーバーを開発したら、PR を提出してここに展示してください！

• https://github.com/wong2/mcp-jina-reader
• https://github.com/nloui/paperless-mcp

🔧 技術詳細

• リソーステンプレートのサポートを追加する予定

関連プロジェクト

• mcp-cli - MCP サーバーのテストとデバッグに使用する CLI
• mcpservers.org - 選りすぐりの MCP サーバーのリスト
• FastMCP - MCP サーバー開発用の Python ライブラリで、このプロジェクトのインスピレーション元