SORACOM Knowledge MCP サーバーは、AI エージェントに次の 3 つのツールを公開します。いずれも読み取り専用で、お客様のアカウントやリソースを変更することはありません。
検索の仕組み (既定の search_mode: hybrid)
hybrid では、キーワード検索と OpenAI の埋め込みモデルによるセマンティック検索を組み合わせ、Reciprocal Rank Fusion (RRF) で統合します。
search_soracom_docs
SORACOM のサービスガイド、ユーザーコンソールの操作手順、サービス概要や料金、IoT レシピを検索します。
| パラメーター | 説明 |
|---|---|
query * | 自然言語の検索クエリ。 |
document_names | 検索対象を特定のサイトに絞り込みます (例: ["developers.soracom.io", "users.soracom.io"])。指定できるサイトはツールのスキーマに含まれています。省略するとすべての対象を検索します。 |
search_mode | hybrid (既定値。キーワード検索とセマンティック検索を統合)、keyword (キーワード検索のみ)、semantic (意味的な類似度による検索のみ) のいずれか。 |
language | English または Japanese。省略するとクエリから自動判定します。 |
max_results | 返す結果の件数。既定値は 16、最大は 32 です。 |
search_api_docs
SORACOM API リファレンス、CLI コマンド、SAM 権限を検索します。query、tag、method、path のうち少なくとも 1 つを指定します。
| パラメーター | 説明 |
|---|---|
query | 自然言語の質問、または API のエンドポイント名。tag、method、path のいずれかを指定する場合は省略できます。 |
tag | サービスタグで絞り込みます (例: Sim、Subscriber、Flux)。大文字小文字を区別しない完全一致です。 |
method | HTTP メソッドで絞り込みます (例: GET、POST)。大文字小文字を区別しない完全一致です。 |
path | API パスの一部で絞り込みます (例: /sims)。大文字小文字を区別しない部分一致です。 |
search_mode | hybrid (既定値。キーワード検索とセマンティック検索を統合)、keyword (キーワード検索のみ)、semantic (意味的な類似度による検索のみ) のいずれか。 |
language | English または Japanese。query を指定した場合はクエリから自動判定します。query を省略する場合は language を明示してください。 |
max_results | 返す結果の件数。既定値は 16、最大は 32 です。 |
get_document
search_soracom_docs または search_api_docs が返したページの全文 (Markdown) を取得します。
| パラメーター | 説明 |
|---|---|
url * | 取得するページの URL。検索結果の url の値をそのまま渡します。ブラウザーで直接開けない形式の URL (分割された API リファレンスなど) が返ることもありますが、その場合もこのツールで内容を取得できます。 |