本文へスキップ
KeuralDocs
開発者向け

プラグイン・MCPサーバー連携

自作のMCPサーバーをKeuralに接続し、デスクトップアプリ用のプラグインパッケージを作成する方法です。

Keuralのプラグインは、MCP(Model Context Protocol)サーバーです。この文書は、自作のMCPサーバーをKeuralに接続する場合や、デスクトップアプリ用のプラグインパッケージを作成する場合の仕様です。

通信方式

プラットフォーム通信方式用途
WebとモバイルHTTP(Streamable HTTP)・SSEインターネットから接続できるリモートMCPサーバー
デスクトップアプリSTDIO・HTTPこのコンピューターで動かすサーバー、社内ネットワークのHTTPサーバー
  • Webの会話では、リモートのHTTP・SSEサーバーだけを使います。STDIOサーバーはデスクトップアプリで実行されます。
  • サーバーのアドレスが/mcpで終わる場合は、通常はStreamable HTTPサーバーです。通信方式はHTTPを選びます。
  • デスクトップアプリのHTTPは、社内ネットワークのアドレス用です。公開インターネットのアドレスは、WebのHTTPで登録します。

直接追加の入力値

設定 → プラグイン → + カスタムMCPを追加の入力欄は次のとおりです。

欄内容
名前必須
説明任意
通信方式上の表を参照
カテゴリー一覧での分類
サーバーURLHTTP・SSEの場合は必須。例: https://example.com/mcp
実行コマンドSTDIOの場合は必須。例: npx
引数STDIOの引数(JSON配列)。例: ["-y", "@scope/server"]
ウェブ検索にこのプラグインを使うオンにすると、ウェブ検索の代わりにこのプラグインを使います。
認証なし・APIキー
ヘッダー名・APIキーの値APIキーの場合。例: ヘッダー名Authorization、値Bearer …

APIキーを選ぶと、リクエストごとに<ヘッダー名>: <値>ヘッダーを付けて送信します。

OAuthで認証するサーバー

組織の管理者がOAuth方式で登録したプラグインは、ユーザーが接続を選んでサインインします。

項目値
サーバーの探索/.well-known/oauth-protected-resource(パスを含む場合 → ルート)、次に/.well-known/oauth-authorization-server
クライアントの登録動的クライアント登録(DCR)
リダイレクトURIhttps://api.keural.ai/api/user-connectors/oauth/callback
リクエストヘッダーAuthorization: Bearer <アクセストークン>

サインインのウィンドウはポップアップで開き、サインインが終わるとプラグインの一覧が更新されます。

ツールの権限

プラグインのツールごとに、実行方法を決めます。

権限動作
常に許可確認なしで実行します。
毎回確認実行前に承認カードを表示します。カードにはツールの引数も一緒に表示されます。
ブロックエージェントがこのツールを使いません。

デスクトップ用プラグインパッケージ

デスクトップアプリは、プラグインのZIPファイル…またはプラグインのフォルダー…からプラグインをインストールします。パッケージには、マニフェストのplugin.jsonが必要です。

{
  "id": "my-plugin",
  "name": "My Plugin",
  "version": "1.0.0",
  "description": "社内システムの照会",
  "mcpServers": {
    "my-server": {
      "command": "node",
      "args": ["server.js"],
      "env": { "API_BASE": "https://intranet.example.com" }
    }
  }
}
フィールド必須内容
idはい英小文字・数字・ハイフン
nameいいえ表示名。ない場合はidを使います。
versionいいえ既定値は1.0.0
descriptionいいえ説明
minAppVersionいいえ必要な最低アプリバージョン
mcpServersいいえMCPサーバーの定義。サーバーごとにcommand・args・envを指定します。
requestsいいえ要求する権限(capabilities、commands、connectors、secrets、permissions)。文字列の配列

Webで登録したSTDIOプラグインは、デスクトップアプリでこのPCにインストールを選んでインストールします。インストール後、認証トークンと環境変数は自分で入力します。

このページの内容