コンテンツにスキップ

出典: https://github.com/microsoft/mcp-for-beginners フォーク元リポジトリ: https://github.com/microsoft/mcp-for-beginners (Microsoft) ライセンス: MIT License


クライアントの作成

クライアントとは、MCPサーバーと直接通信してリソース、ツール、プロンプトをリクエストするカスタムアプリケーションやスクリプトのことです。サーバーと対話するためのグラフィカルインターフェースを提供するインスペクターツールを使用する場合とは異なり、自分でクライアントを作成することで、プログラム的かつ自動化された操作が可能になります。これにより、開発者はMCPの機能を自分のワークフローに統合し、タスクを自動化し、特定のニーズに合わせたカスタムソリューションを構築できます。

概要

このレッスンでは、Model Context Protocol (MCP) エコシステム内でのクライアントの概念を紹介します。独自のクライアントを作成し、それをMCPサーバーに接続する方法を学びます。

学習目標

このレッスンの終わりまでに、次のことができるようになります:

  • クライアントが何をできるかを理解する。
  • 独自のクライアントを作成する。
  • MCPサーバーに接続し、サーバーが期待通りに動作することを確認する。

クライアント作成の手順

クライアントを作成するには、以下の手順を実行する必要があります:

  • 適切なライブラリをインポートする。以前と同じライブラリを使用しますが、異なる構造を使用します。
  • クライアントをインスタンス化する。クライアントインスタンスを作成し、選択したトランスポートメソッドに接続します。
  • リストするリソースを決定する。MCPサーバーにはリソース、ツール、プロンプトが用意されているため、どれをリストするかを決めます。
  • クライアントをホストアプリケーションに統合する。サーバーの機能を把握したら、ホストアプリケーションに統合し、ユーザーがプロンプトやコマンドを入力した際に対応するサーバー機能が呼び出されるようにします。

これで、全体的に何をするのかが理解できたので、次に例を見てみましょう。

クライアントの例

以下はクライアントの例です:

TypeScript

import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";

const transport = new StdioClientTransport({
  command: "node",
  args: ["server.js"]
});

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

await client.connect(transport);

// List prompts
const prompts = await client.listPrompts();

// Get a prompt
const prompt = await client.getPrompt({
  name: "example-prompt",
  arguments: {
    arg1: "value"
  }
});

// List resources
const resources = await client.listResources();

// Read a resource
const resource = await client.readResource({
  uri: "file:///example.txt"
});

// Call a tool
const result = await client.callTool({
  name: "example-tool",
  arguments: {
    arg1: "value"
  }
});

上記のコードでは以下を行っています:

  • ライブラリをインポートする。
  • クライアントのインスタンスを作成し、stdioを使用して接続する。
  • プロンプト、リソース、ツールをリストし、それらをすべて呼び出す。

これで、MCPサーバーと通信できるクライアントが完成しました。

次の演習セクションでは、コードスニペットを1つずつ分解して説明します。

演習:クライアントの作成

前述の通り、コードを説明しながら進めていきます。可能であれば、コードを書きながら進めてください。

-1- ライブラリのインポート

必要なライブラリをインポートします。クライアントと選択したトランスポートプロトコル(今回はstdio)への参照が必要です。stdioはローカルマシン上で動作するものに適したプロトコルです。SSEは別のトランスポートプロトコルで、今後の章で紹介しますが、今回はstdioを使用します。

TypeScript

import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";

Python

from mcp import ClientSession, StdioServerParameters, types
from mcp.client.stdio import stdio_client

.NET

using Microsoft.Extensions.AI;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Hosting;
using ModelContextProtocol.Client;
using ModelContextProtocol.Protocol.Transport;

Java

Javaでは、前回の演習で作成したMCPサーバーに接続するクライアントを作成します。Java Spring Bootプロジェクト構造を使用し、src/main/java/com/microsoft/mcp/sample/client/フォルダーにSDKClientという新しいJavaクラスを作成し、以下のインポートを追加します:

import java.util.Map;
import org.springframework.web.reactive.function.client.WebClient;
import io.modelcontextprotocol.client.McpClient;
import io.modelcontextprotocol.client.transport.WebFluxSseClientTransport;
import io.modelcontextprotocol.spec.McpClientTransport;
import io.modelcontextprotocol.spec.McpSchema.CallToolRequest;
import io.modelcontextprotocol.spec.McpSchema.CallToolResult;
import io.modelcontextprotocol.spec.McpSchema.ListToolsResult;

次に、インスタンス化に進みます。

-2- クライアントとトランスポートのインスタンス化

トランスポートのインスタンスとクライアントのインスタンスを作成する必要があります:

TypeScript

const transport = new StdioClientTransport({
  command: "node",
  args: ["server.js"]
});

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

await client.connect(transport);

上記のコードでは以下を行っています:

  • stdioトランスポートインスタンスを作成。サーバーを見つけて起動するためのコマンドと引数を指定する必要があることに注意してください。

    const transport = new StdioClientTransport({
        command: "node",
        args: ["server.js"]
    });
    
  • 名前とバージョンを指定してクライアントをインスタンス化。

    const client = new Client(
    {
        name: "example-client",
        version: "1.0.0"
    });
    
  • 選択したトランスポートにクライアントを接続。

    await client.connect(transport);
    

Python

from mcp import ClientSession, StdioServerParameters, types
from mcp.client.stdio import stdio_client

# Create server parameters for stdio connection
server_params = StdioServerParameters(
    command="mcp",  # Executable
    args=["run", "server.py"],  # Optional command line arguments
    env=None,  # Optional environment variables
)

async def run():
    async with stdio_client(server_params) as (read, write):
        async with ClientSession(
            read, write
        ) as session:
            # Initialize the connection
            await session.initialize()



if __name__ == "__main__":
    import asyncio

    asyncio.run(run())

上記のコードでは以下を行っています:

  • 必要なライブラリをインポート。
  • サーバーパラメータオブジェクトをインスタンス化。これを使用してサーバーを実行し、クライアントで接続できるようにします。
  • runメソッドを定義。このメソッドはstdio_clientを呼び出し、クライアントセッションを開始します。
  • エントリーポイントを作成し、asyncio.runrunメソッドを提供。

.NET

using Microsoft.Extensions.AI;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Hosting;
using ModelContextProtocol.Client;
using ModelContextProtocol.Protocol.Transport;

var builder = Host.CreateApplicationBuilder(args);

builder.Configuration
    .AddEnvironmentVariables()
    .AddUserSecrets<Program>();



var clientTransport = new StdioClientTransport(new()
{
    Name = "Demo Server",
    Command = "dotnet",
    Arguments = ["run", "--project", "path/to/file.csproj"],
});

await using var mcpClient = await McpClientFactory.CreateAsync(clientTransport);

上記のコードでは以下を行っています:

  • 必要なライブラリをインポート。
  • stdioトランスポートを作成し、クライアントmcpClientを作成。このクライアントを使用してMCPサーバーの機能をリストおよび呼び出します。

「Arguments」には、.csprojまたは実行可能ファイルのいずれかを指定できます。

Java

public class SDKClient {

    public static void main(String[] args) {
        var transport = new WebFluxSseClientTransport(WebClient.builder().baseUrl("http://localhost:8080"));
        new SDKClient(transport).run();
    }

    private final McpClientTransport transport;

    public SDKClient(McpClientTransport transport) {
        this.transport = transport;
    }

    public void run() {
        var client = McpClient.sync(this.transport).build();
        client.initialize();

        // Your client logic goes here
    }
}

上記のコードでは以下を行っています:

  • http://localhost:8080で実行されるMCPサーバーを指すSSEトランスポートを設定するメインメソッドを作成。
  • トランスポートをコンストラクタパラメータとして受け取るクライアントクラスを作成。
  • runメソッド内で、トランスポートを使用して同期MCPクライアントを作成し、接続を初期化。
  • HTTPベースの通信に適したSSE(Server-Sent Events)トランスポートを使用。

-3- サーバー機能のリスト

これで、プログラムを実行すればクライアントが接続できるようになりました。ただし、まだ機能をリストしていないので、次にそれを行います:

TypeScript

// List prompts
const prompts = await client.listPrompts();

// List resources
const resources = await client.listResources();

// list tools
const tools = await client.listTools();

Python

# List available resources
resources = await session.list_resources()
print("LISTING RESOURCES")
for resource in resources:
    print("Resource: ", resource)

# List available tools
tools = await session.list_tools()
print("LISTING TOOLS")
for tool in tools.tools:
    print("Tool: ", tool.name)

ここでは、利用可能なリソースをlist_resources()、ツールをlist_toolsでリストし、それらを出力しています。

.NET

foreach (var tool in await client.ListToolsAsync())
{
    Console.WriteLine($"{tool.Name} ({tool.Description})");
}

上記は、サーバー上のツールをリストする例です。各ツールについて、その名前を出力します。

Java

// List and demonstrate tools
ListToolsResult toolsList = client.listTools();
System.out.println("Available Tools = " + toolsList);

// You can also ping the server to verify connection
client.ping();

上記のコードでは以下を行っています:

  • listTools()を呼び出して、MCPサーバーから利用可能なすべてのツールを取得。
  • ping()を使用して、サーバーへの接続が機能していることを確認。
  • ListToolsResultには、ツールの名前、説明、入力スキーマなどの情報が含まれています。

これで、すべての機能をキャプチャしました。次に、それらをいつ使用するかという問題があります。このクライアントは非常にシンプルで、機能を使用する際には明示的に呼び出す必要があります。次の章では、独自の大規模言語モデル(LLM)にアクセスできるより高度なクライアントを作成します。今回は、サーバー上の機能をどのように呼び出すかを見てみましょう:

-4- 機能の呼び出し

機能を呼び出すには、正しい引数と場合によっては呼び出す対象の名前を指定する必要があります。

TypeScript

// Read a resource
const resource = await client.readResource({
  uri: "file:///example.txt"
});

// Call a tool
const result = await client.callTool({
  name: "example-tool",
  arguments: {
    arg1: "value"
  }
});

// call prompt
const promptResult = await client.getPrompt({
    name: "review-code",
    arguments: {
        code: "console.log(\"Hello world\")"
    }
})

上記のコードでは以下を行っています:

  • リソースを読み取る。readResource()を呼び出し、uriを指定します。サーバー側では以下のように見えるはずです:

    server.resource(
        "readFile",
        new ResourceTemplate("file://{name}", { list: undefined }),
        async (uri, { name }) => ({
          contents: [{
            uri: uri.href,
            text: `Hello, ${name}!`
          }]
        })
    );
    

    サーバー上のfile://{name}に対して、クライアントのurifile://example.txtが一致します。example.txtnameにマッピングされます。

  • ツールを呼び出す。nameargumentsを指定して呼び出します:

    const result = await client.callTool({
        name: "example-tool",
        arguments: {
            arg1: "value"
        }
    });
    
  • プロンプトを取得する。getPrompt()nameargumentsで呼び出します。サーバーコードは以下のようになります:

    ``typescript server.prompt( "review-code", { code: z.string() }, ({ code }) => ({ messages: [{ role: "user", content: { type: "text", text:Please review this code:

${code}` } }] }) );

そのため、クライアントコードは以下のようになります:

```typescript
const promptResult = await client.getPrompt({
    name: "review-code",
    arguments: {
        code: "console.log(\"Hello world\")"
    }
})

Python

# Read a resource
print("READING RESOURCE")
content, mime_type = await session.read_resource("greeting://hello")

# Call a tool
print("CALL TOOL")
result = await session.call_tool("add", arguments={"a": 1, "b": 7})
print(result.content)

上記のコードでは以下を行っています:

  • read_resourceを使用してgreetingというリソースを呼び出し。
  • call_toolを使用してaddというツールを呼び出し。

.NET

  1. ツールを呼び出すコードを追加します:
var result = await mcpClient.CallToolAsync(
    "Add",
    new Dictionary<string, object?>() { ["a"] = 1, ["b"] = 3  },
    cancellationToken:CancellationToken.None);
  1. 結果を出力するコードを追加します:
Console.WriteLine(result.Content.First(c => c.Type == "text").Text);
// Sum 4

Java

// Call various calculator tools
CallToolResult resultAdd = client.callTool(new CallToolRequest("add", Map.of("a", 5.0, "b", 3.0)));
System.out.println("Add Result = " + resultAdd);

CallToolResult resultSubtract = client.callTool(new CallToolRequest("subtract", Map.of("a", 10.0, "b", 4.0)));
System.out.println("Subtract Result = " + resultSubtract);

CallToolResult resultMultiply = client.callTool(new CallToolRequest("multiply", Map.of("a", 6.0, "b", 7.0)));
System.out.println("Multiply Result = " + resultMultiply);

CallToolResult resultDivide = client.callTool(new CallToolRequest("divide", Map.of("a", 20.0, "b", 4.0)));
System.out.println("Divide Result = " + resultDivide);

CallToolResult resultHelp = client.callTool(new CallToolRequest("help", Map.of()));
System.out.println("Help = " + resultHelp);

上記のコードでは以下を行っています:

  • CallToolRequestオブジェクトを使用してcallTool()メソッドで複数の計算ツールを呼び出し。
  • 各ツール呼び出しで、ツール名とそのツールに必要な引数のMapを指定。
  • サーバーツールは特定のパラメータ名(例:"a"、"b")を期待。
  • 結果は、サーバーからの応答を含むCallToolResultオブジェクトとして返されます。

-5- クライアントの実行

クライアントを実行するには、ターミナルで以下のコマンドを入力します:

TypeScript

package.jsonの"scripts"セクションに以下を追加:

"client": "tsx && node build/client.js"
npm run client

Python

以下のコマンドでクライアントを呼び出します:

python client.py

.NET

dotnet run

Java

まず、MCPサーバーがhttp://localhost:8080で実行されていることを確認します。その後、クライアントを実行します:

# Build you project
./mvnw clean compile

# Run the client
./mvnw exec:java -Dexec.mainClass="com.microsoft.mcp.sample.client.SDKClient"

または、03-GettingStarted-client\solution\javaフォルダーにある完全なクライアントプロジェクトを実行します:

# Navigate to the solution directory
cd 03-GettingStarted/02-client/solution/java

# Build and run the JAR
./mvnw clean package
java -jar target/calculator-client-0.0.1-SNAPSHOT.jar

課題

この課題では、学んだことを活用して独自のクライアントを作成します。

以下のサーバーを使用して、クライアントコードを通じて呼び出してください。また、サーバーにさらに多くの機能を追加して、より興味深いものにしてみてください。

TypeScript

import { McpServer, ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { z } from "zod";

// Create an MCP server
const server = new McpServer({
  name: "Demo",
  version: "1.0.0"
});

// Add an addition tool
server.tool("add",
  { a: z.number(), b: z.number() },
  async ({ a, b }) => ({
    content: [{ type: "text", text: String(a + b) }]
  })
);

// Add a dynamic greeting resource
server.resource(
  "greeting",
  new ResourceTemplate("greeting://{name}", { list: undefined }),
  async (uri, { name }) => ({
    contents: [{
      uri: uri.href,
      text: `Hello, ${name}!`
    }]
  })
);

// Start receiving messages on stdin and sending messages on stdout

async function main() {
  const transport = new StdioServerTransport();
  await server.connect(transport);
  console.error("MCPServer started on stdin/stdout");
}

main().catch((error) => {
  console.error("Fatal error: ", error);
  process.exit(1);
});

Python

# server.py
from mcp.server.fastmcp import FastMCP

# Create an MCP server
mcp = FastMCP("Demo")


# Add an addition tool
@mcp.tool()
def add(a: int, b: int) -> int:
    """Add two numbers"""
    return a + b


# Add a dynamic greeting resource
@mcp.resource("greeting://{name}")
def get_greeting(name: str) -> str:
    """Get a personalized greeting"""
    return f"Hello, {name}!"

.NET

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using ModelContextProtocol.Server;
using System.ComponentModel;

var builder = Host.CreateApplicationBuilder(args);
builder.Logging.AddConsole(consoleLogOptions =>
{
    // Configure all logs to go to stderr
    consoleLogOptions.LogToStandardErrorThreshold = LogLevel.Trace;
});

builder.Services
    .AddMcpServer()
    .WithStdioServerTransport()
    .WithToolsFromAssembly();
await builder.Build().RunAsync();

[McpServerToolType]
public static class CalculatorTool
{
    [McpServerTool, Description("Adds two numbers")]
    public static string Add(int a, int b) => $"Sum {a + b}";
}

このプロジェクトを参照して、プロンプトとリソースを追加する方法を確認してください。

また、プロンプトとリソースを呼び出す方法も確認してください。

解答

solutionフォルダーには、このチュートリアルで説明したすべての概念を示す、完全に実行可能なクライアント実装が含まれています。各ソリューションには、クライアントとサーバーのコードが別々の自己完結型プロジェクトとして整理されています。

📁 ソリューション構造

ソリューションディレクトリはプログラミング言語ごとに整理されています:

solution/
├── typescript/          # TypeScript client with npm/Node.js setup
│   ├── package.json     # Dependencies and scripts
│   ├── tsconfig.json    # TypeScript configuration
│   └── src/             # Source code
├── java/                # Java Spring Boot client project
│   ├── pom.xml          # Maven configuration
│   ├── src/             # Java source files
│   └── mvnw            # Maven wrapper
├── python/              # Python client implementation
│   ├── client.py        # Main client code
│   ├── server.py        # Compatible server
│   └── README.md        # Python-specific instructions
├── dotnet/              # .NET client project
│   ├── dotnet.csproj    # Project configuration
│   ├── Program.cs       # Main client code
│   └── dotnet.sln       # Solution file
└── server/              # Additional .NET server implementation
    ├── Program.cs       # Server code
    └── server.csproj    # Server project file

🚀 各ソリューションに含まれる内容

各言語固有のソリューションには以下が含まれます:

  • チュートリアルのすべての機能を備えた完全なクライアント実装
  • 適切な依存関係と設定を備えたプロジェクト構造
  • 簡単にセットアップして実行できるビルドおよび実行スクリプト
  • 言語固有の手順を記載した詳細なREADME
  • エラーハンドリングと結果処理の例

📖 ソリューションの使用方法

  1. 希望する言語フォルダーに移動
cd solution/typescript/    # For TypeScript
cd solution/java/          # For Java
cd solution/python/        # For Python
cd solution/dotnet/        # For .NET
  1. 各フォルダーのREADMEの指示に従う
  2. 依存関係のインストール
  3. プロジェクトのビルド
  4. クライアントの実行

  5. 期待される出力例

Prompt: Please review this code: console.log("hello");
Resource template: file
Tool result: { content: [ { type: 'text', text: '9' } ] }

完全なドキュメントと手順については、📖 ソリューションドキュメントを参照してください。

🎯 完全な例

このチュートリアルで説明したすべての機能を示す、完全に動作するクライアント実装を提供しています。これらの例は、リファレンス実装または独自プロジェクトの出発点として使用できます。

利用可能な完全な例

言語 ファイル 説明
Java client_example_java.java SSEトランスポートを使用した完全なJavaクライアント(包括的なエラーハンドリング付き)
C# client_example_csharp.cs stdioトランスポートを使用した完全なC#クライアント(サーバーの自動起動機能付き)
TypeScript client_example_typescript.ts MCPプロトコルを完全サポートするTypeScriptクライアント
Python client_example_python.py 非同期/awaitパターンを使用した完全なPythonクライアント

各完全な例には以下が含まれます:

  • 接続の確立とエラーハンドリング
  • サーバーの探索(ツール、リソース、プロンプトなど)
  • 計算操作(加算、減算、乗算、除算、ヘルプ)
  • 結果処理とフォーマットされた出力
  • 包括的なエラーハンドリング
  • ステップごとのコメント付きのクリーンでドキュメント化されたコード

完全な例の開始方法

  1. 希望する言語を選択し、上記の表から選択します。
  2. 完全な例ファイルを確認し、実装全体を理解します。
  3. complete_examples.mdの指示に従って例を実行します。
  4. 例を修正および拡張して、特定のユースケースに適応させます。

これらの例を実行およびカスタマイズする方法の詳細なドキュメントについては、📖 完全な例のドキュメントを参照してください。

💡 ソリューションと完全な例の違い

ソリューションフォルダー 完全な例
ビルドファイルを含む完全なプロジェクト構造 単一ファイルの実装
依存関係を含む実行可能な状態 教育的なリファレンス
本番環境に近いセットアップ 言語間の比較が可能
言語固有のツールを使用 学習目的に最適
両方のアプローチには価値があります。solution folder は完全なプロジェクト向けに使用し、complete examples は学習や参考資料として活用してください。

重要なポイント

この章の重要なポイントは、クライアントに関する以下の内容です:

  • サーバー上の機能を発見し、呼び出すために使用できます。
  • 自身が起動する際にサーバーを開始することができます(この章のように)。ただし、クライアントは既存のサーバーに接続することも可能です。
  • 前章で説明したInspectorのような代替手段と並んで、サーバーの機能をテストする優れた方法です。

追加リソース

サンプル

次は何をする?

免責事項:
この文書は、AI翻訳サービス Co-op Translator を使用して翻訳されています。正確性を追求しておりますが、自動翻訳には誤りや不正確な部分が含まれる可能性があることをご承知ください。元の言語で記載された文書が正式な情報源とみなされるべきです。重要な情報については、専門の人間による翻訳を推奨します。この翻訳の使用に起因する誤解や誤解釈について、当方は一切の責任を負いません。