For the complete documentation index, see llms.txt. This page is also available as Markdown.

MCP serverツール設定

Agent BuilderやMCPノードで利用できるMCPserver各ツールの説明や設定方法を記載しています。

※Allganizeと記載のあるMCPツールのAPIキーはプロジェクト設定>全般>APIキーでご確認いただけます。 その他の各MCPツールで必要になるAPIキーは自社でご用意されたAPIキーをご利用ください。

目次

Allganize Alli

概要

Alli LLM App Marketの基本的な機能を利用できます。

ツール名:search_documents

  • ツール概要

    • ナレッジベースから、セマンティック検索(キーワード一致ではなく文章の“意味”を理解して探す検索)を使用して関連ドキュメントを検索します。

      このツールは、検索クエリに一致する ドキュメントを見つけます。 各結果には、ドキュメントのタイトルと全文、作成・更新日時などのメタデータが含まれます。

  • 利用例

    • 「会社の方針」に関するすべての文書を探す

    • 特定のハッシュタグが付けられた文書を検索する

    • 特定の条件に一致する文書を見つける

  • 入出力(引数と戻り値)

    • 戻り値(出力): タイトル、全文、メタデータを含む文書のリスト

設定項目
説明

query

検索クエリ

hashtags

指定したハッシュタグが付与されたドキュメントから検索します。

exclude_hashtags

検索結果から除外するハッシュタグを指定します。

hashtags_operation

検索手法をANDかORで指定します。デフォルトはOR検索です。

exclude_hashtags_operatiion

除外する複数のハッシュタグをANDかORで指定します。デフォルトはOR検索です。

ツール名:search_faqs

  • ツール概要

    • 検索クエリに一致する FAQを検索します。

      このツールは、質問と回答のペアで構成された構造化された FAQを検索します。 検索クエリとの関連性に基づき、FAQ のランキングが返されます。

  • 利用例

    • 「パスワードリセット」に関する FAQ を探す

    • 特定カテゴリのよくある質問を検索する(ハッシュタグを使用)

    • 顧客の特定の質問に対する回答を見つける

  • 入出力(戻り値)

    • 戻り値(出力): 質問文、回答テキスト、作成・更新日時などのメタデータを含む FAQ エントリのリスト

設定項目
説明

query

検索クエリ

hashtags

指定したハッシュタグが付与されたFAQから検索します。

exclude_hashtags

検索結果から除外するハッシュタグを指定します。

hashtags_operation

検索手法をANDかORで指定します。デフォルトはOR検索です。

exclude_hashtags_operatiion

除外する複数のハッシュタグをANDかORで指定します。デフォルトはOR検索です。

ツール名:generative_answer

  • ツール概要

    • ナレッジベースのドキュメントをもとに、AI による回答を生成します。

      このツールは 2つのステップ で動作します:

      1. ナレッジベースを検索して関連するドキュメントを見つける

      2. LLM を使用して、見つけたドキュメントに基づき自然言語で回答を生成する

      生成される回答は複数の情報源から統合され、必要に応じてどのドキュメントを参照したかの引用を含めることもできます。

  • 利用例

    • 「会社の休暇制度はどうなっていますか?」

    • 「パスワードをリセットするにはどうすればいいですか?」

    • 「ソフトウェアの動作環境は何ですか?」

    • 特定のドキュメントカテゴリ(ハッシュタグを使用)に絞った回答の生成

  • 入出力(戻り値)

    • 戻り値(出力): 生成された回答テキスト、必要に応じて参照ドキュメントの引用

設定項目
説明

query

検索クエリ

hashtags

指定したハッシュタグが付与されたFAQから検索します。

exclude_hashtags

検索結果から除外するハッシュタグを指定します。

model_name

回答生成に利用するモデルを指定します。デフォルトモデルはGPT4oです。

include_citations

回答生成結果に根拠となるドキュメント情報を含めるかどうかを"true"か"false"で指定します。

prompt_group_id

回答生成に使用するプロジェクトのグループプロンプトを選択します。この設定は、デフォルトで準備されたグループプロンプトから変更を行い利用している場合などに有効です。 IDはプロジェクト設定>プロンプト管理>回答生成タブの選択します。使用するグループプロンプトを選択した際に表示されるURLからIDが確認できます。 例 :https://app.alli.ai/projects/UHJvamVjdDo2NDljYTRjZDMzMGY2MDZkYWRjOPOjNjE=/settings/prompt-management/generative-answer/groups/TExNUHJvbXB0R3JvdXA6NjUzNzc3MzA5GHUyMGE2ZjlhM2Q5OTIw

knowledge_base_ids

検索を特定のドキュメントIDに限定します。

hashtags_operation

検索手法をANDかORで指定します。デフォルトはOR検索です。

exclude_hashtags_operatiion

除外する複数のハッシュタグをANDかORで指定します。デフォルトはOR検索です。

ツール名:search_knowledge_base_nodes

  • ツール概要

    • ナレッジベース内のファイルやフォルダを、メタデータや属性で検索します。

      このツールは、ドキュメント内の 内容ではなく、ナレッジベースの構造自体(ファイルやフォルダ)を検索します。 各ファイル・フォルダのメタデータ(名前、種類、サイズ、処理状況、ハッシュタグ、作成・更新日時など)を返します。

  • 利用例

    • 特定フォルダ内のすべての PDF ファイルを一覧表示する

    • 「quarterly-report」タグが付いたすべての文書を検索する

      処理中のファイルを確認する

    • ナレッジベースのフォルダ構造を閲覧する

    • 名前パターンでファイルを検索する

  • 入出力(戻り値)

    • 戻り値(出力):ナレッジベース内のノード(ファイル/フォルダ)のリストとメタデータ

      • ID

      • 名前

      • 種類

      • サイズ

      • 状態

      • ハッシュタグ

      • 親フォルダ

      • 作成・更新日時

設定項目
説明

search_term

フィルタリングするための検索キーワード

hashtags

指定したハッシュタグが付与されたドキュメントから検索します。

exclude_hashtags

検索結果から除外するハッシュタグを指定します。

parent_folder_ids

検索対象とするフォルダID。最上位レベルに挿入するにはnull。

node_type

file、またはfolderを指定します。

process_state

解析プロセスのステータスを以下から指定します

・initializing ・parsing ・parsing_fail ・completed ・retrying ・post_parsing ・post_parsing_fail ・post_completed ・post_retrying

limit

表示する結果数を制限します。デフォルトは10です。最大値は 100 です。

after

API でレスポンス本文を取得できるカーソル値を入れることができます (カーソルベースのページング) このフィールドが指定されていない場合、サーバーはフィルタリングされた値の最初の値から制限まで送信した回数を返します。

hashtags_operation

検索手法をANDかORで指定します。デフォルトはOR検索です。

exclude_hashtags_operation

除外する複数のハッシュタグをANDかORで指定します。デフォルトはOR検索です。

ツール名:get_knowledge_base_text

  • ツール概要

    • 特定のナレッジベース内のドキュメントの、プレーンテキスト全体を取得します。

      このツールは、ナレッジベース内のドキュメントファイルから すべてのテキスト内容 を抽出して返します。 テキストは元のファイル形式(PDF、DOCX など)から解析・整形され、プレーンテキストとして取得されます。

  • 利用例

    • 特定のポリシー文書の全文を読む

    • 検索で見つけたドキュメントから内容を抽出し、さらに処理する

    • 要約や分析のためにドキュメント全文を取得する

    • 特定の詳細を確認するために内容を取得する

  • 入出力(戻り値)

    • 戻り値(出力): ドキュメントのタイトル、ドキュメントの全文テキスト

設定項目
説明

node_id

ナレッジベースノードIDを指定します

ツール名:Hybrid Retrieval

  • ツール概要

    • 質問内容に対して、最も関連性の高いドキュメントのページやセクションを取得します。

      このツールは、ナレッジベース内の すべての文書ページ を対象に、キーワード検索(BM25) と セマンティック検索(ベクトル類似度) を組み合わせたハイブリッド方式で検索します。 検索結果として、ページ単位の 抜粋テキスト を関連性順に返します。

  • 利用例

    • 「データ保持ポリシー」に言及しているページを探す

    • 「従業員福利厚生」について記載されているページはどれか

    • セキュリティ要件に関する抜粋箇所を特定する

    • 特定の文書セクションから引用や証拠を探す

    • 特定のトピックに関する文脈を、正確な原文テキストで取得する

  • 入出力(戻り値)

    • 戻り値(出力):

    • ページ単位のドキュメント情報リスト(以下の項目を含む) ・ランキング(関連度スコア) ・ドキュメントタイトル ・ページ番号またはシート名 ・そのページの正確なテキスト内容 ・ナレッジベース ID(参照用)

設定項目
説明

question

検索クエリ

max_document_clues

関連ページを取得する数を決定します。 デフォルトは3です。

bm25_score_weight

キーワード検索の重みです。この値が高いほど、キーワードスコアがより反映されます。0から9の間の値が適切であり、値が0の場合はキーワード検索が使用されないことを意味します。デフォルト値は9です。

text_vector_score_weight

ドキュメント内容に対するセマンティック検索の重みです。この値が高いほど、より多く反映されます。0から9の値が適切で、値が0の場合は文書内容に対するセマンティック検索が使用されません。デフォルト値は1です。

title_vector_score_weight

ドキュメントタイトルに対するセマンティック検索の重みです。同様に、0から9の間の値が適切であり、値が0の場合は文書タイトルに対するセマンティック検索が使用されないことを意味します。デフォルト値は0です。

hashtags

指定したハッシュタグが付与されたドキュメントから検索します。

hashtags_operator

検索手法をANDかORで指定します。デフォルトはOR検索です。

exclude_hashtags

検索結果から除外するハッシュタグを指定します。

exclude_hashtags_operator

除外する複数のハッシュタグをANDかORで指定します。デフォルトはOR検索です。

target_folders

検索対象フォルダ名

folder_ids

検索対象のフォルダーのID

knowledge_base_ids

特定のナレッジベース内を検索するためのID

use_keywords

検索のためのキーワードを抽出して使用するかどうか を""true""または""false""で指定します。

use_clue_feedback

検索結果を改善するためにフィードバックデータを使用するかどうか を""true""または""false""で指定します。

ツール名:deep_research

  • ツール概要

    • Web検索とナレッジベースのドキュメントを横断して、トピックに関する詳細なリサーチを実行します。 複数の情報源を収集・分析し、引用付きで構造化された包括的な回答を生成します。 調査計画の立案から回答生成までを自動で行うため、単純な検索よりも踏み込んだ調査・レポート作成に適しています。

  • 利用例

    • 「競合製品の最新動向を調査してレポートにまとめる」

    • 「社内ドキュメントとWeb情報の両方を踏まえた市場分析を行う」

    • 「特定テーマについて、根拠(引用)付きの詳細な回答を作成する」

  • 入出力(戻り値)

    • 戻り値(出力): 引用を含む、構造化された包括的な回答テキスト

設定項目
説明

query

調査するトピックまたは質問内容。

use_web_search

Web検索を利用するかどうかを"true"か"false"で指定します。

use_document_search

ナレッジベースのドキュメント検索を利用するかどうかを"true"か"false"で指定します。

research_model

調査(計画・情報収集)に利用するモデルを指定します。

generation_model

最終回答の生成に利用するモデルを指定します。

max_plan_steps

調査計画の最大ステップ数を指定します。値を大きくするとより多段階の調査を行います。

ツール名:search_answer_feedback

  • ツール概要

    • クエリと意味的に類似する、人によって検証済みの回答を検索します。 過去に肯定的なフィードバック(高評価/Thumbs-up)を受けた質問や、ユーザーが提案した改善済みの回答を、類似度順に返します。 過去に承認された回答を根拠として、応答の品質を安定させたい場合に利用します。

  • 利用例

    • 「過去に高評価を得た類似質問の回答を参照して回答する」

    • 「ユーザーが改善提案した回答を優先的に活用する」

    • 「承認済みの回答をベースに一貫した応答を生成する」

  • 入出力(戻り値)

    • 戻り値(出力): 類似度順に並んだ、検証済みの過去の質問・回答のリスト

設定項目
説明

query

検索クエリ。

max_results

返される結果の最大数を指定します。

threshold

類似度のしきい値。この値以上の類似度を持つ回答のみが返されます。

Allganize Document

概要

指定のドキュメントのインプット、アウトプット等を行います。

ツール名:Download V1

  • ツール概要

    • URL または Allganize システムからファイルをローカルの一時ストレージにダウンロードします。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • tmpfs パス、ローカルパス、メタデータ

設定項目
説明

file_path

Allganizeシステム内のダウンロード用HTTP/HTTPS URLまたはファイル名(設定例:https://example.com/file.pdf' または 'document.docx')

file_name

一時ファイルのファイル名。(設定例:document.csv'、'data.xlsx')

ツール名:Upload V1

  • ツール概要

    • tmpfs ストレージから Allganize システムにファイルをアップロードします。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • アップロード結果、ダウンロード URL、メタデータ

設定項目
説明

file_name

一時ファイルのファイル名。(設定例:https://example.com/file.pdf' または 'document.docx')

tmpfs

ダウンロードツールからのtmpfsパス(設定例:document.csv'、'data.xlsx')

filename

Allganizeシステムで希望するファイル名(必須)。元のファイル名と異なっていても構いません。(設定例:tmpfs://workspace/document.pdf)

ツール名:Upload V2

  • ツール概要

    • ファイルをAllganizeのナレッジベースにアップロードし、ドキュメントインジェスト(DI:解析・インデックス化)を実行します。 storage_type パラメータにより、個人ストレージと共有ストレージの両方に対応します。 アップロード後、wait_complete で指定した秒数まで処理ステータスをポーリングします。処理が完了していない場合は、現在の状態と kb_id を返すため、後から get_kb_status で再確認できます。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • success: 処理の成否を示すブール値

      • kb_id: ステータス追跡用のナレッジベースノードID

      • filename: アップロードしたファイル名

      • file_size_bytes: ファイルサイズ

      • storage_type: 'personal'(個人)または 'shared'(共有)

      • process_state: 処理状態(COMPLETED | PARSING | PARSING_FAIL | RETRYING など)

      • message: ポーリングがタイムアウトした場合にのみ表示されます

設定項目
説明

tmpfs

アップロードするファイルへのtmpfsパス(ダウンロードツール等から取得)。

filename

ナレッジベースに登録するファイル名。

storage_type

保存先を 'personal'(個人)または 'shared'(共有)で指定します。

wait_complete

処理ステータスをポーリングする最大秒数。完了前に返った場合は kb_id で後から確認できます。

ツール名:Write V1

  • ツール概要

    • コンテンツを一時ファイルに書き込み、tmpfs パスを返します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • tmpfs のパスとメタデータ

設定項目
説明

content

一時ファイルに書き込むコンテンツ。テキスト、JSON、XMLなどを指定できます。

filename

一時ファイルのファイル名。(設定例:document.txt'、'data.json')

ツール名:Copy V1

  • ツール概要

    • tmpfs 上のファイルを、別の場所へ新しいファイル名でコピーします。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • dict: 新しいtmpfsパスとメタデータを含みます

設定項目
説明

source_tmpfs

コピー元ファイルへのtmpfsパス。

new_filename

コピー先の新しいファイル名。

ツール名:Get Kb Status

  • ツール概要

    • ナレッジベースノードのドキュメントインジェスト(処理)ステータスを確認します。 upload_v2 でアップロードしたファイルの処理状況を確認するために使用します(特に、インジェスト完了前にアップロードが返された場合)。 wait_complete で指定した秒数までステータスをポーリングします。ステータスが COMPLETED または PARSING_FAIL の場合は即時に返します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • success: 処理の成否を示すブール値

      • kb_id: ナレッジベースノードID

      • name: ナレッジベース内のファイル名

      • process_state: 処理状態(COMPLETED | PARSING | PARSING_FAIL | RETRYING など)

      • message: ポーリングがタイムアウトした場合にのみ表示されます

設定項目
説明

kb_id

ステータスを確認するナレッジベースノードID。

wait_complete

ステータスをポーリングする最大秒数。

ツール名:Extract Ast From Docx V1

  • ツール概要

    • 実行の分割/マージをサポートして、DOCX ファイルから AST (抽象構文ツリー) を抽出します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • AST構造と処理済みのtmpfsパス

        • ast: 段落と表を含む要素配列を持つドキュメントAST

        • has_more: 制限を超える要素があるかどうかを示すブール値

        • tmpfs_path: 後続の操作のための処理済みファイルへのパス

設定項目
説明

tmpfs

DOCXファイルへのtmpfsパス(必須)。ダウンロードツールから取得したtmpfs://path/to/file.docx形式である必要があります。(設定例:tmpfs://contracts/agreement.docx)

extract_fields

抽出するRunModelフィールドのリスト(オプション、デフォルト:['text'])。使用可能なフィールド:'text'、'font'、'size'、'bold'、'italic'、'color'。(設定例:['text'、'bold'、'font'])

from_element

ページ区切りの開始要素番号 (オプション、デフォルト: 0)。抽出を開始する 0 ベースのインデックス。

limit

抽出する要素の最大数(オプション、デフォルト:100、最大:100)。ページ区切りのサイズを制御します。

ツール名:Apply Ast To Docx V1

  • ツール概要

    • 実行の分割/マージをサポートする DOCX ファイルに AST (抽象構文ツリー) の変更を適用します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 成功ステータスとファイル情報

設定項目
説明

tmpfs

DOCXファイルへのtmpfsパス(必須)。tmpfs://path/to/file.docx形式である必要があります。ファイルはその場で変更されます。(例:'tmpfs://drafts/proposal.docx')

elements

アクションベースの操作を持つ要素のリスト。

ツール名:Search Ast From Docx V1

  • ツール概要

    • 正規表現パターンに一致する DOCX ファイル内の段落を検索し、その AST を返します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 一致する段落のASTとメタデータ

        • ast: 一致する段落のみを含むドキュメントAST

        • matches_found: 見つかった一致する段落の数

        • total_paragraphs_checked: チェックされた段落の総数

        • regex_pattern: 使用した正規表現パターン

        • tmpfs_path: 処理対象ファイルへのパス

設定項目
内容

tmpfs

DOCXファイルへのtmpfsパス(必須)。ダウンロードツールから取得したtmpfs://path/to/file.docx形式である必要があります(例:'tmpfs://20250714123456/file.docx')

regex

段落テキストにマッチする正規表現パターン(必須)。完全な正規表現構文をサポートします。

from_element

ページ区切りの開始要素番号 (オプション、デフォルト: 0)。検索を開始する 0 ベースのインデックス。

limit

返される一致する段落の最大数(オプション、デフォルト:100、最大:100)。結果のページ区切りを制御します。

ツール名:Apply Global Changes To Docx V1

  • ツール概要

    • DOCX ファイル内のすべての段落にグローバル書式設定とテキスト修正を適用します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 成功ステータス

      • ファイル情報

      • 適用された変更

設定項目
説明

tmpfs

DOCXファイルへのtmpfsパス(必須)。

font

すべてのテキストに適用するフォント名(オプション)。例:「Arial」、「Times New Roman」、「Calibri」。指定しない場合は、フォントは変更されません。

font_size

すべてのテキストに適用するフォントサイズ(ポイント単位)(オプション)。例:8、12、14。指定しない場合は、フォントサイズは変更されません。

word_replacements

単語置換辞書(オプション)。形式:{'old_word': 'new_word'}。例:{'old_term': 'new_term', 'wrong_spelling': 'correct_spelling'}。指定されていない場合、単語置換は適用されません。

numbers_conversion

数値の幅の変換(オプション)。指定可能な値:'to_zenkaku'(全角), 'to_hankaku'(半角)。指定しない場合は、数値は変更されません。

alpha_conversion

アルファベットの幅の変換(オプション)。指定可能な値:'to_zenkaku'(全角), 'to_hankaku'(半角)。指定しない場合は、アルファベットは変更されません。

symbols_conversion

記号の幅の変換(オプション)。指定可能な値:「to_zenkaku」(全角)、「to_hankaku」(半角)。指定しない場合は、記号は変更されません。

katakana_conversion

カタカナの幅変換(オプション)。指定可能な値:'to_zenkaku'(全角), 'to_hankaku'(半角)。指定しない場合は、カタカナは変更されません。

highlight

すべてのテキストに適用するハイライトカラー(オプション)。使用可能な色:'yellow'、'cyan'、'green'、'magenta'、'blue'、'red'、'darkBlue'、'darkCyan'、'darkGreen'、'darkMagenta'、'darkRed'、'darkYellow'、'gray25'、'gray50'、'black'、'white'。指定しない場合は、ハイライトカラーは変更されません。

shading

すべてのテキストに適用する背景のシェーディング色(HEX形式、オプション)を指定します。例:'FFFF00'(黄色)、'FF0000'(赤)、'E6F3FF'(水色)。接頭辞「#」は含めないでください。指定しない場合、シェーディングは変更されません。

ツール名:Read V1

  • ツール概要

    • CSV、JSON、コードファイル、ログ、設定ファイルなど、あらゆるテキストファイル形式をサポートします。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • テキストの内容と行情報

設定項目
説明

tmpfs

tmpfs:// は、テキスト読み取り可能なファイルです。

.md、.txt、.csv、.tsv、.json、.py、.js、.java、.cpp、.go、.rs、.log、.yml、.yaml、.xml、.html、.css、.sql、.sh、.bat、.ini、.cfg、.conf などをサポートしています。

from_lines

読み取り開始行番号(0 ベース)。デフォルトは 0(先頭から開始)です。

read_lines

読み取る行数。デフォルトは1000です。大きなドキュメントの場合は、より小さい値を使用してください。

ツール名:Search V1

  • ツール概要

    • インテリジェントなヘッダー検出を備えたスマートなテキスト検索。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 一致とメタデータを含む検索結果

設定項目

tmpfs

tmpfs:// 検索対象ファイルへのパス。テキスト読み取り可能なファイル形式であればどれでもサポートされます。

pattern

Ripgrep互換の正規表現パターン。

before_context

一致前の行数(0~20)。

after_context

一致後の行数(0~20)。

multiline

複数行検索モードを有効にします。行の境界をまたいでパターンを一致させることができます。複数行または複数セクションにまたがるコンテンツを検索したい場合に使用します。デフォルトはFalseです。

case_insensitive

大文字と小文字を区別しない検索を実行します。デフォルトはFalseです。

ツール名:Search From Json V1

  • ツール概要

    • スマート ガイダンス付きの jq 式を使用して JSON データを検索およびフィルター処理します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • フォーマットされた JSON データ、メタデータ、およびオプションのスキーマを含む検索結果

設定項目
説明

tmpfs

tmpfs:// 検索するJSONファイルへのパス。有効なJSONファイルである必要があります。

jq_query

JSONデータを検索/フィルタリングするためのjq式。

output_format

出力形式。

max_results

返される結果の最大数(0の場合は無制限)。大きな結果セットの出力サイズを制限するために使用します。

include_schema

結果にJSONスキーマ分析を含めます。Trueの場合、ファイル構造に基づいてJSONスキーマと推奨クエリが返されます。

ツール名:Replace V1

  • ツール概要

    • 高度なオプションを使用して正規表現パターンを使用してテキストを検索および置換します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 統計情報とメタデータを含む置換結果

  • 使用例

    • 単純なテキスト置換

      • replace_v1("tmpfs://docs/readme.txt", "TODO", "COMPLETED")

    • グループキャプチャを使用した大文字と小文字を区別しない置換

      • replace_v1("tmpfs://code/main.py", "function\s+(\w+)", "def $1", case_insensitive=True)

    • 複数行にまたがる置換

      • replace_v1("tmpfs://docs/guide.md", "old section.*?end section", "new content", multiline=True)

    • テスト用の限定的な置換

      • replace_v1("tmpfs://data/large_file.csv", "old,value", "new,value", max_replacements=5)

    • 不要なコンテンツを削除

      • replace_v1("tmpfs://logs/debug.log", "DEBUG:.*", "")

設定項目
内容

tmpfs

tmpfs:// は変更するファイルへのパスです。テキスト読み取り可能なファイル形式であれば何でもサポートされます。

pattern

検索と置換のための正規表現パターン

replacement

一致した文字列を置換する文字列

multiline

複数行検索モードを有効にします。行の境界をまたいでパターンを一致させることができます。複数行または複数セクションにまたがるコンテンツを検索して置換したい場合に使用します。デフォルトはFalseです。

case_insensitive

大文字と小文字を区別しない置換を実行します。デフォルトは False です。

max_replacements

置換する最大回数(0の場合は無制限)。安全性やテストのために変更を制限する場合に使用します。

ツール名:Append V1

  • ツール概要

    • ファイルの末尾にテキストを追記します。 既存の内容を変更せずに、ファイルの末尾へコンテンツを追加したい場合に使用します。 次のような用途に有効です:

      • ログファイルへの新規エントリの追加

      • CSV/TSVファイルへの行の追加

      • ドキュメントへの新規セクションの追加

      • 複数の操作にまたがる結果の蓄積

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • dict: 成否ステータス、ファイルサイズ、追記したテキストの長さを含む追記結果

設定項目
説明

tmpfs

追記対象ファイルへのtmpfsパス。テキスト読み取り可能なファイル形式をサポートします。

text

ファイルの末尾に追記するテキスト内容。

ツール名:Csvkit V1

  • ツール概要

    • データの分析と操作のために、CSV ファイルに対して csvkit コマンドを直接実行します。

設定項目
説明

command

実行するcsvkitコマンド。

tmpfs

入力ファイルへのパス(tmpfs://、HTTP/HTTPS URL、または通常のパス)。in2csvの場合:.xlsx、.xls、.json、.ndjson、.geojson、.dbf、固定長ファイルをサポートします。その他のコマンドの場合:CSVファイル。

args

csvkitコマンドのコマンドライン引数。

output_path

出力ファイルのパス(オプション)。指定されていない場合は、tmpfsパスが自動的に生成されます。情報のみを表示するコマンド(csvstat、csvlook)には適用されません。

ツール名:Convert V1

  • ツール概要

    • 柔軟な入出力サポートを備えたユニバーサル ファイル形式コンバーター。

設定項目
内容

tmpfs

tmpfs:// は変換するファイルへのパスです。

output_format

出力形式です。

reference_docx

MDからDOCXへの変換時にスタイルを設定するための参照DOCXファイルへのtmpfs://パス(省略可)です。この参照ドキュメントには、フォント、スタイル、ヘッダー、ページレイアウトなどの書式設定テンプレートが用意されています。MarkdownからDOCXへの変換にのみ使用されます。

template

MDからPDFへの変換時に、オプションのtmpfs://パスでPandocテンプレートファイルを指定します。テンプレートは、PDF出力時のドキュメントのレイアウト、スタイル、フォーマットを制御します。LaTeXテンプレートおよびその他のPandoc互換形式をサポートします。MarkdownからPDFへの変換にのみ使用されます。

ツール名:Get Presigned Url V1

  • ツール概要

    • tmpfs ファイルをユーザーと共有するためのダウンロード可能な URL を生成します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): メタデータ付きの署名済み URL 情報

設定項目
説明

tmpfs

tmpfsファイルへのパス(tmpfs://タイムスタンプ/ファイル名形式)。

expires_in

URLの有効期限(秒)。デフォルト:3600(1時間)。最大:604800(7日間)

ツール名:Extract Ast From Pptx V1

  • ツール概要

    • PPTX ファイルから AST (抽象構文ツリー) を抽出します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • AST構造と処理後のtmpfsパスが含まれます

        • ast: 図形とコンテンツを含むスライド配列を含むプレゼンテーションAST

        • tmpfs_path: 後続の操作のための処理済みファイルへのパス

        • filename: 元のファイル名

設定項目
説明

tmpfs

PPTXファイルへのtmpfsパス(必須)。ダウンロードツールから取得したtmpfs://path/to/file.pptx形式である必要があります。

ツール名:Build Pptx From Ast V1

  • ツール概要

    • AST (抽象構文ツリー) 構造から PPTX ファイルを構築します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 成功ステータスとファイル情報

        • success: 操作の成功を示すブール値

        • tmpfs_path: 作成されたPPTXファイルへのパス

        • filename: 作成されたPPTXファイル名

設定項目
説明

tmpfs

PPTXファイルが作成されるtmpfsパス(必須)。tmpfs://path/to/file.pptx 形式である必要があります。

ast

プレゼンテーションを表すAST構造(必須)。スライド、図形、コンテンツを含むPresentationModelスキーマに従う必要があります。AST構造の重要なルール: - 'paragraphs'配列には段落オブジェクト('runs'フィールドを持つ辞書)のみを含める必要があります。 - 'runs'配列には、'text'フィールドを持つ辞書のみを含める必要があります。 - text_frameまたは段落内に図形レベルのフィールド('rotation'など)を混在させないでください。

template_pptx

ベースとして使用するオプションのPPTXテンプレート。(1) 組み込みテンプレート名(使用可能なテンプレートを確認するにはget_pptx_template_list_v1()を使用してください)、または(2) tmpfsパス('tmpfs://path/to/template.pptx'など)のいずれかを指定できます。指定すると、スライドはこのテンプレートのレイアウトを使用し、元のデザイン(フォント、色、マスタースライド)は保持されます。

ツール名:Get Pptx Template List V1

  • ツール概要

    • 利用可能な PPTX スライド テンプレートのリストを取得します。

ツール名:Get Pptx Template Ast V1

  • ツール概要

    • 特定の PPTX テンプレートの AST 構造を取得します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • テンプレートASTと包括的なメタデータが含まれます。

        • success: 操作の成功を示すブール値

        • name: テンプレート名

        • description: テンプレートの説明と目的

        • pptx_template: 推奨されるPPTXテンプレート(汎用テンプレートの場合はnull)

        • finalize_deck_v1 で適切なスタイルを設定すると有効になります。

        • ast: テンプレートの完全なAST構造

        • metadata: テンプレート情報(テンプレートの種類によって構造が異なります)

        • components: コンポーネントの説明とプレースホルダー

        • style: スタイル識別子

        • language: 対象言語(例: 'ja'、'en'、'ko')

設定項目
説明

name

取得するテンプレート名(必須)。利用可能なテンプレートを確認するには、get_pptx_template_list_v1 を使用してください。

ツール名:Create New Deck V1

  • ツール概要

    • 新しいプレゼンテーション デッキを作成し、一意のデッキ ID を返します。

ツール名:Add Ast To Deck V1

  • ツール概要

    • 既存のデッキに 1 つ以上のスライド AST を追加します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 更新ステータスが含まれます

        • success: 操作の成功を示すブール値

        • deck_id: 更新されたデッキのID

        • total_slides: デッキ内の現在のスライド数

        • slides_added: 追加されたスライド番号のリスト (例: [0, 1, 2])

        • slides_count: この操作で追加されたスライドの数

設定項目
内容

deck_id

スライドを追加するデッキID(必須)。create_new_deck_v1から取得されます。

slide_ast

追加するスライドのASTデータ(必須)。

ツール名:Finalize Deck V1

  • ツール概要

    • デッキを完成させ、PPTX ファイルを生成します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • ファイナライズ結果が含まれます

        • success: 操作の成功を示すブール値

        • deck_id: ファイナライズされたデッキID

        • total_slides: プレゼンテーションのスライド数

        • tmpfs_path: 生成されたPPTXファイルへのパス

        • filename: 生成されたPPTXファイル名

設定項目
内容

deck_id

確定するデッキID(必須)。create_new_deck_v1から取得されます。

template_pptx

ベースとして使用するオプションのPPTXテンプレート。

ツール名:Apply Content To Pptx V1

  • ツール概要

    • 書式を保持したまま、PPTX ファイルの内容を変更します。 このツールは、既存のPPTXに対して以下の処理を行います:

      1. tmpfs からPPTXファイルを開く

      2. 図形(シェイプ)を名前で特定する

      3. すべての書式(色、フォント等)を保持したままテキスト内容を置換する

      4. 新しいファイルとして保存する

      ワークフロー:

      1. download_v1() でドキュメントストレージからPPTXを取得

      2. extract_ast_from_pptx_v1() で図形名と構造を確認

      3. apply_content_to_pptx_v1()(本ツール)で内容を変更

      4. get_presigned_url_v1() でダウンロードURLを取得

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • dict: 成功ステータスと出力ファイル情報を含みます

        • success: 成功した場合 True

        • tmpfs_path: 生成されたPPTXファイルへのパス

        • filename: 出力ファイル名

        • slide_index: 変更されたスライドのインデックス

        • shapes_modified: 変更された図形の数

  • 注意事項

    • テキストの書式(色・フォント・サイズ)は保持されます。

    • content 辞書に指定された図形のみが変更されます。

    • テキスト内の改行には改行コード(\n)を使用してください。

    • 図形名は大文字・小文字を区別し、完全一致が必要です。

設定項目
説明

tmpfs_path

PPTXファイルへのパス(download_v1 から取得)。

slide_index

変更対象のスライド番号(0始まり)。

content

図形名と内容を対応付けた辞書。

output_filename

出力ファイル名。

ツール名:Extract Tables From Pdf V1

  • ツール概要

    • PDF ファイルからすべての表を抽出します。ヘッダーの自動検出に対応しています。 このツールは自動で以下を行います:

      1. 全ページから表を検出する

      2. ヒューリスティックによりヘッダー行を検出する(結合ヘッダーにも対応)

      3. 複数行ヘッダーをアンダースコア区切りで平坦化する(例:「Category_SubCategory」)

      4. 列名を整形する(スペースや特殊文字をアンダースコアに置換)

      5. 最終列の改行以降のテキストを除去する(フッター混入の補正)

      6. 数値から桁区切りを除去する(例:「1,234,567」→「1234567」)

      7. ヘッダー列(先頭列)が空の行を削除する

      8. 各表をCSVファイルとして tmpfs に保存する

      抽出されたCSVは csvkit_v1 でSQL的なクエリに利用できます。

  • 利用例

    • 予算PDFからすべての表を抽出し、CSVとして取得する

    • 抽出したCSVを csvkit_v1 で集計・分析する

    • ヘッダー検出の信頼度(detection_confidence)を確認し、低い場合は transform_table_from_pdf_v1 で手動調整する

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • success: 処理の成否を示すブール値

      • source_tmpfs / source_filename: 元のPDFのtmpfsパス・ファイル名

      • total_pages: PDFのページ数

      • total_tables: 抽出された表の数(画像PDFや表が無い場合は0)

      • tables: 各表の情報(table_index、page_number、detected_header_rows、detection_confidence(high/medium/low)、rows、data_rows、columns、headers、tmpfs_path、preview など)

      • diagnostics: PDF解析情報(is_likely_image_pdf、total_images、ページ別の has_text 等)

  • 注意事項

    • テキストベースのPDFのみ対応しています(スキャン/画像PDFは非対応)。

    • 'diagnostics.is_likely_image_pdf' が True の場合、画像PDFのため表抽出はできません(OCRが必要です)。

    • ヘッダー検出の信頼度が 'low' の場合は、transform_table_from_pdf_v1 での手動確認を推奨します。

設定項目
説明

tmpfs

表を抽出するPDFファイルへのtmpfsパス(ダウンロードツールから取得)。

ツール名:Transform Table From Pdf V1

  • ツール概要

    • PDF 内の特定の表を、カスタムヘッダーや変換ルールを用いて変換します。 次のような場合に使用します:

      • extract_tables_from_pdf_v1 のヘッダー検出が誤っていた(信頼度が low)

      • 分析前にデータのクレンジング・絞り込み・加工が必要

      • 列名の変更や特定のデータ処理を行いたい

      変換(transforms)は指定した順序で適用されます。推奨順序は「クレンジング → 絞り込み → 列名変更 → 並べ替え」です。

  • 利用例

    • 自動検出が誤った表に対し header_rows を手動指定してヘッダーを修正する

    • 数値列のカンマ除去(clean_numeric)や行の絞り込み(filter_rows)を行う

    • 列名を英語にリネーム(rename_columns)して分析しやすくする

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • success: 処理の成否を示すブール値

      • table_index / page_number: 対象表のインデックス・ページ番号

      • header_rows_applied: 適用したヘッダー行数(自動または手動)

      • transforms_applied: 適用した変換アクション名のリスト

      • original_shape / result_shape: 変換前後の行数・列数

      • headers: 変換後の最終列名

      • tmpfs_path: 保存されたCSVファイルへのパス(csvkit_v1 で利用可)

      • preview: 検証用の先頭3行

設定項目
説明

tmpfs

対象PDFファイルへのtmpfsパス。

table_index

変換対象の表のインデックス(extract_tables_from_pdf_v1 で確認)。

header_rows

ヘッダー行数を手動指定します(自動検出の上書き)。

header_separator

複数行ヘッダーを平坦化する際の区切り文字。

transforms

適用する変換アクションのリスト(strip_whitespace、filter_rows、clean_numeric、rename_columns、sort_rows、drop_empty_rows、deduplicate 等)。指定順に適用されます。

output_filename

出力するCSVファイル名。

ツール名:Extract Content From Pdf V1

  • ツール概要

    • PDF ファイルの指定ページから、テキスト・表・画像を抽出します。 ページ範囲を柔軟に指定でき、以下の3種類のコンテンツを抽出します:

      1. テキスト:各ページのテキストを読み順を保持して抽出(テキストベースPDFのみ)

      2. 表:ヘッダー自動検出付きで表を抽出(extract_tables_from_pdf_v1 と同じロジック、信頼度付き)

      3. 画像:埋め込み画像をPNGとして tmpfs に保存し、パスと座標・サイズを返す

      ページ番号は1始まりで、from_page・to_page はいずれも範囲に含まれます(to_page を未指定にすると最終ページまで)。

  • 利用例

    • 年次報告書の10〜20ページからテキストのみを抽出して分析する(表・画像をオフ)

    • 財務諸表セクションから表のみを抽出する

    • パンフレットから画像のみを抽出し、get_presigned_url_v1 で共有用URLを発行する

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • success / source_tmpfs / source_filename / total_pages

      • extracted_page_range: 抽出したページ範囲(from_page、to_page)

      • summary: 統計(pages_extracted、total_text_length、total_tables、total_images)

      • pages: ページ別コンテンツ(text、tables、images、page_info)

  • 注意事項

    • テキスト・表の抽出はテキストベースPDFのみ対応です(スキャンPDFはOCRが必要で非対応)。

    • 用途に応じて不要な抽出をオフにすると高速化できます(例:テキストのみなら extract_tables=False, extract_images=False)。

設定項目
説明

tmpfs

対象PDFファイルへのtmpfsパス。

from_page

抽出開始ページ(1始まり、範囲に含む)。

to_page

抽出終了ページ(1始まり、範囲に含む)。未指定(None)で最終ページまで。

extract_text

テキストを抽出するかどうかを"true"か"false"で指定します。

extract_tables

表を抽出するかどうかを"true"か"false"で指定します。

extract_images

画像を抽出するかどうかを"true"か"false"で指定します。

ツール名:Write Excel Cells V1

  • ツール概要

    • Excel(.xlsx)ファイルの指定セルに、値の書き込みや画像の挿入を行います。 ワークブックを開いて各セルに値を設定または画像を挿入し、保存してS3へ同期します。 ファイルロックにより同時編集の競合を防止します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • dict: 成否ステータス、tmpfs_path、filename、書き込んだセル数(cells_written)

  • 使用例

    • 単一セルに書き込み

      • write_excel_cells_v1("tmpfs://20250710/report.xlsx", 0, [{"cell": "A1", "value": "Hello"}])

    • セルに画像を挿入

      • write_excel_cells_v1("tmpfs://20250710/report.xlsx", 0, [{"cell": "C5", "value": "tmpfs://20250710/chart.png", "type": "image", "width": 200, "height": 150}])

設定項目
説明

tmpfs

対象の.xlsxファイルへのtmpfsパス。

sheet_index

対象ワークシートのインデックス(0始まり)。

cells

書き込むセルの辞書リスト。テキストは 'cell' + 'value'、画像は 'cell' + 'value'(tmpfsパス)+ 'type'='image'(任意で 'width'/'height')。

ツール名:Read Excel Sheet V1

  • ツール概要

    • Excel シートを読み取ります。セルの値に加えて、書式(太字・塗りつぶし)やセル結合の情報も取得します。 各セルの値と書式、結合セル範囲のリストを返すため、シートの視覚的構造(ヘッダー・階層・グループ化)を把握できます。 空セルも結果に含まれます(埋めるべき空欄の特定に有効)。値も書式も無い完全な空行はスキップされます。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • dict: シートのメタデータ、結合セル(merged_cells)リスト、セルデータを含む行(rows)

  • 使用例

    • 先頭シートの最初の50行を読み取り

      • read_excel_sheet_v1("tmpfs://20250710/report.xlsx")

    • 2番目のシートの10〜59行目、A〜E列を読み取り

      • read_excel_sheet_v1("tmpfs://20250710/report.xlsx", sheet_index=1, from_row=10, col_range="A:E")

設定項目
説明

tmpfs

対象の.xlsxファイルへのtmpfsパス。

sheet_index

対象ワークシートのインデックス(0始まり)。

from_row

読み取り開始行(1始まり)。

row_limit

返される最大行数。

col_range

"A:E" のような列範囲。全列の場合は None。

ツール名:Extract Document Content V1

  • ツール概要

    • ドキュメントファイルから、テキスト・表・画像を抽出します。 ファイル形式を自動判定し、適切な抽出方法を適用する汎用ツールです。主要なドキュメント形式に対応します。 対応形式:Word(.docx/.doc)、PowerPoint(.pptx/.ppt)、Excel(.xlsx/.xls)、PDF(.pdf)、CSV(.csv:区切り文字・エンコーディング自動判定)、テキスト(.txt/.md:UTF-8・CP949・EUC-KR・Latin-1 等に対応)。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • success: 抽出の成否を示すブール値

      • file_path: 元のtmpfsパス

      • file_type: 判定されたファイル種別(docx/pdf/excel/pptx/csv/text)

      • extraction_method: 使用した抽出方法

      • content: 抽出内容(text、tables[headers/data]、images[tmpfsパス]、metadata)

      • processing_time: 抽出にかかった時間(秒)

      • message / error: ステータスメッセージ/エラー

  • 注意事項

    • 事前に download_v1 で tmpfs_path を取得してから使用してください。

    • 画像は返された tmpfs パスをそのまま使用してください(パスを変更しない)。画像は一時的でセッション内のみ有効です。

    • 大きなドキュメントは抽出に数秒かかる場合があります。

設定項目
説明

tmpfs_path

対象ドキュメントへのtmpfsパス(download_v1 から取得。tmpfs://タイムスタンプ/ファイル名.拡張子 形式)。

offset

読み取り開始位置(オフセット)。

limit

取得する最大件数。

Allganize Sample Test MCP Server

概要

開発およびテスト用のMCP Serverを例示構成でテストをする

ツール名:Echo With Config

  • ツール概要

    • 入力テキストとすべての設定変数をそのまま返す(Echoする)機能

  • 利用例

    • 「会社の方針」に関するすべての文書を探す

    • 特定のハッシュタグが付けられた文書を検索する

    • 特定の条件に一致する文書を見つける

  • 入出力(引数と戻り値)

    • 引数(入力):

      • input_text: 返却する任意のテキスト文字列

    • 戻り値(出力):

      • 入力テキストと、すべての設定変数を含む結果

  • 入力例

    • 「input」: 「hello」「timestamp」: 「2025-01-01T12:00:00Z」, 「credentials」: { 「api_url」: 「https://api.allganize.ai」, 『api_key』: 「ASDF...」, 「project_id」: 「proj-123」, 「agent_email」: 「agent@example.com」 }, 「example_vars」: { 「example1」: 「foo」, 「example2」: 「bar」, 「example3」: 「baz」, 『example4』: 「qux」 }

ツール名:Time Sleep

  • ツール概要

    • 指定した秒数だけスリープし、タイミング情報を返す機能

  • 利用例

    • 「会社の方針」に関するすべての文書を探す

    • 特定のハッシュタグが付けられた文書を検索する

    • 特定の条件に一致する文書を見つける

  • 入出力(引数と戻り値)

    • 引数(入力):

      • スリープする秒数(正の整数である必要があります)

    • 戻り値(出力):

      • 入力時刻、スリープ時間、終了時刻などのタイミング情報を含む辞書

  • 入力例

    • "input_seconds": 5, "start_time": "2025-01-07T10:30:00.123456", "end_time": "2025-01-07T10:30:05.125678", "actual_sleep_seconds": 5.002222, "message": "Slept for 5 seconds (actual: 5.002222s)"

Allganize Time

概要

時刻操作のためのMCP Serverです。Agentが現在時刻の取得、タイムゾーン間の変換、日時の計算を行えるようにします。

ツール名:Get Current Time

  • ツール概要

    • 指定したタイムゾーンの現在時刻を取得します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • timezone: 指定したタイムゾーン

      • datetime: タイムゾーン付きISO形式の現在日時

      • is_dst: サマータイム(夏時間)が有効かどうか

設定項目
説明

timezone

現在時刻を取得するタイムゾーン(例:'Asia/Tokyo'、'America/New_York')。

ツール名:Get Current Date

  • ツール概要

    • 指定したタイムゾーンの現在の日付を、曜日情報とあわせて取得します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • date: ISO形式の現在日付(YYYY-MM-DD)

      • weekday: 数値の曜日(0=月曜, 1=火曜, ..., 6=日曜)

      • weekday_name: 曜日の正式名称(例:'Monday'、'Tuesday')

      • timezone: 指定したタイムゾーン

  • 注意事項

    • 日付と曜日は、時差によりタイムゾーン間で異なる場合があります。

設定項目
説明

timezone

現在日付を取得するタイムゾーン(例:'Asia/Tokyo')。

ツール名:Convert Time

  • ツール概要

    • タイムゾーン間で時刻を変換します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • source: 変換元タイムゾーンの情報(日時・DSTステータス)

      • target: 変換先タイムゾーンの情報(変換後の日時・DSTステータス)

      • time_difference: タイムゾーン間の時差(例:'+5h'、'-8.5h')

  • 注意事項

    • 変換には当日の日付が使用されるため、時差により日付が異なる場合があります。

設定項目
説明

source_timezone

変換元のタイムゾーン(例:'Asia/Seoul')。

time

変換する時刻(例:'09:00')。

target_timezone

変換先のタイムゾーン(例:'America/Los_Angeles')。

ツール名:Calculate Datetime

  • ツール概要

    • 指定した日時に各種の操作を適用して、日時を計算します。 期間の加算・減算や、特定の日付・時刻要素の設定が可能な高機能ツールです。 操作は順序どおりに適用されます(まず相対的な変更、その後に絶対的な設定)。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • original_datetime: 入力した日時

      • original_weekday / original_weekday_name: 入力日時の曜日(数値・名称)

      • calculated_datetime: 操作適用後の結果日時

      • calculated_weekday / calculated_weekday_name: 結果日時の曜日(数値・名称)

      • timezone: 使用したタイムゾーン

設定項目
説明

datetime_str

基準となる日時(ISO形式)。

timezone

計算に使用するタイムゾーン。

relative_days

加算・減算する日数(相対指定)。

relative_weeks

加算・減算する週数(相対指定)。

relative_months

加算・減算する月数(相対指定)。

relative_years

加算・減算する年数(相対指定)。

relative_hours

加算・減算する時間数(相対指定)。

relative_minutes

加算・減算する分数(相対指定)。

relative_seconds

加算・減算する秒数(相対指定)。

day

日を特定の値に設定(絶対指定)。

weekday

曜日を特定の値に設定(絶対指定)。

month

月を特定の値に設定(絶対指定)。

year

年を特定の値に設定(絶対指定)。

hour

時を特定の値に設定(絶対指定)。

minute

分を特定の値に設定(絶対指定)。

second

秒を特定の値に設定(絶対指定)。

Alli Built-in Tools

概要

プラットフォームの組み込みツール(ナレッジベース検索など)を利用できます。 収録ツールは Allganize Alli と同一で、以下の8ツールが含まれます。 各ツールの引数・戻り値は「Allganize Alli」セクションの該当ツールをご参照ください。

ツール名
概要
詳細の参照先

Search Documents(search_documents)

セマンティック検索でナレッジベースから関連ドキュメントを検索します。

Allganize Alli > search_documents

Search FAQs(search_faqs)

ナレッジベース内のFAQ(質問・回答ペア)を検索します。

Allganize Alli > search_faqs

Generate Answer(generative_answer)

ナレッジベースのドキュメントをもとにAIによる回答を生成します。

Allganize Alli > generative_answer

Search KB Nodes(search_knowledge_base_nodes)

ナレッジベースのノード(ファイル・フォルダ)をメタデータで検索します。

Allganize Alli > search_knowledge_base_nodes

Get KB Text(get_knowledge_base_text)

特定のナレッジベースドキュメントの全文テキストを取得します。

Allganize Alli > get_knowledge_base_text

Hybrid Retrieval(retrieval)

BM25とセマンティック検索を組み合わせたハイブリッド検索を行います。

Allganize Alli > retrieval

Deep Research(deep_research)

Web検索とナレッジベースを横断し、引用付きの詳細な回答を生成します。

本書①> deep_research

Search Answer Feedback(search_answer_feedback)

検証済み(高評価・改善提案)の類似質問の回答を検索します。

本書①> search_answer_feedback

概要

Allganize API を介してFAQを検索するためのMCP Serverです。AgentがナレッジベースからFAQエントリを検索・取得できるようにします。

ツール名:Search Faq

  • ツール概要

    • Allganize のナレッジベース内のFAQを検索します。 指定したクエリに一致するFAQを検索し、確信度スコア(confidence score)順にランキングした結果を返します。 ハッシュタグによる絞り込みや、特定タグの除外に対応しています。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • result: 一致したFAQのリスト(question、answer、confidence、hashtags など)

      • count: 返された結果の総数

設定項目
説明

query

検索クエリ。

max_results

返される結果の最大数。

hashtags

指定したハッシュタグが付与されたFAQから検索します。

hashtags_operator

複数ハッシュタグの検索手法をANDかORで指定します。

excluding_hashtags

検索結果から除外するハッシュタグを指定します。

Box MCP Server

概要

Box API と OAuth 認証を統合した MCP サーバーにより、Boxのファイルおよびフォルダー管理、共有、共同作業機能が有効になります。

設定項目
説明

ALLI_API_URL

AlliのAPI接続URL(設定例:https://backend.alli.ai/api

ALLI_API_KEY

AlliのAPIキー(設定例:US1XJA)

ALLI_PROJECT_ID

AlliのプロジェクトID(設定例:UHJvamV)

ALLI_AGENT_EMAIL

Alliのアカウントemailアドレス(設定例:lli@alli.ai)

OAuth 2.0 Client ID 

「boxと連携」ボタンから、 Boxアカウントと連携します

ツール名:Box Upload File

  • ツール概要

    • tmpfs から Box にファイルをアップロードします

  • 戻り値(出力):

    • ID、名前、サイズ、作成タイムスタンプなどのアップロードされたファイルの情報を含む辞書。

設定項目
説明

tmpfs_path

アップロードするファイルの tmpfs パス(設定例:tmpfs://20240101120000/hello.txt)

file_name

ファイル名(設定例:hello.txt)

parent_folder_id

親フォルダの ID (ルートフォルダには「0」を使用します)(設定例:0,123456789)

ツール名:Box Download File

  • ツール概要

    • Box から tmpfs にファイルをダウンロードします

  • 戻り値(出力):

    • tmpfs_path: ファイルが保存されているtmpfsパス

    • filename: 元のファイル名

    • file_size_bytes: ファイルサイズ(バイト単位)

    • metadata: ファイル情報(ID、名前、サイズなど

設定項目
説明

file_id

ダウンロードするファイルの ID(設定例:123456789)

ツール名:Box Update File

  • ツール概要

    • tmpfs から Box のファイルを更新します。

  • 戻り値(出力):

    • 更新されたファイル情報を含む辞書。

設定項目
説明

file_id

アップデートするファイルの ID(設定例:123456789)

tmpfs_path

更新するファイルの tmpfs パス(設定例:tmpfs://20240101120000/updated_file.txt)

ツール名:Box Delete File

  • ツール概要

    • Boxからファイルを削除します

  • 戻り値(出力):

    • 削除が成功したことを示す辞書。

設定項目
説明

file_id

削除するファイルの ID(設定例:123456789)

ツール名:Box Get File Info

  • ツール概要

    • Boxにあるファイルの詳細情報を取得します

  • 戻り値(出力):

    • ID、名前、サイズ、作成日/更新日、親フォルダなどのファイルメタデータを含む辞書。

設定項目
説明

file_id

詳細情報を取得するファイルの ID(設定例:123456789)

ツール名:Box Copy File

  • ツール概要

    • Boxにあるファイルを別のフォルダにコピーします。

  • 戻り値(出力):

    • コピーされたファイルの情報を含む辞書。

設定項目
説明

file_id

コピーするファイルの ID(設定例:123456789)

parent_folder_id

コピー先フォルダのID(設定例:987654321)

new_name

コピーされたファイルの新しい名前(設定例:copy_of_file.txt)

ツール名:Box Move File

  • ツール概要

    • 移動されたファイルの情報を含む辞書。

  • 戻り値(出力):

    • コピーされたファイルの情報を含む辞書。

設定項目
説明

file_id

移動するファイルの ID(設定例:123456789)

parent_folder_id

移動先のフォルダのID(設定例:987654321)

new_name

ファイルの新しい名前(設定例:renamed_file.txt)

ツール名:Box Create Folder

  • ツール概要

    • Box に新しいフォルダを作成します。

  • 戻り値(出力):

    • 作成されたフォルダのIDと名前を含む辞書型データ。

設定項目
説明

folder_name

作成するフォルダの名前(設定例:New Folder)

parent_folder_id

親フォルダのID (ルートフォルダの場合は '0' を使用)(設定例:123456789)

ツール名:Box List Folder Items

  • ツール概要

    • Boxのフォルダ内のアイテムを一覧表示します。

  • 戻り値(出力):

    • 以下の内容を含む辞書

      • entries: ファイルとフォルダのリスト

      • total_count: アイテムの総数

      • limit: 1ページあたりのアイテム数

      • offset: 現在のオフセット

設定項目
説明

folder_id

詳細情報を取得するフォルダのID(設定例:123456789)

limit

取得する詳細情報のアイテムの最大数(最大 1000)(設定例:50)

offset

取得する詳細情報のアイテムの開始オフセット(設定例:50)

ツール名:Box Get Folder Info

  • ツール概要

    • Boxのフォルダの詳細情報を取得します。

  • 戻り値(出力):

    • フォルダのメタデータ(ID、名前、サイズ、アイテム数、親フォルダなど)を含む辞書型データ。

設定項目
説明

folder_id

詳細情報を取得するフォルダのID(設定例:123456789)

ツール名:Box Delete Folder

  • ツール概要

    • Boxからフォルダを削除します。

  • 戻り値(出力):

    • 削除が成功したことを示す辞書。

設定項目
説明

folder_id

削除するフォルダのID(設定例:123456789)

recursive

フォルダ内にアイテムが含まれている場合、削除を許可するか (許可する=True, 許可しない=False)

ツール名:Box Copy Folder

  • ツール概要

    • Boxのフォルダを別の場所にコピーします。

  • 戻り値(出力):

    • コピーされたフォルダの情報を含む辞書。

設定項目
説明

recursive

フォルダ内にアイテムが含まれている場合、削除を許可するか (許可する=True, 許可しない=False)

folder_id

コピーするフォルダのID(設定例:123456789)

parent_folder_id

コピー先の親フォルダのID(設定例:987654321)

ツール名:Box Move Folder

  • ツール概要

    • Boxのフォルダを別の場所に移動します。

  • 戻り値(出力):

    • 移動されたフォルダの情報を含む辞書。

設定項目
説明

folder_id

移動するフォルダのID(設定例:123456789

parent_folder_id

移動先の親フォルダのID(設定例:987654321)

  • ツール概要

    • Box内のファイルとフォルダを検索します。

  • 戻り値(出力):

    • 以下の項目を含む辞書:

      • entries: 一致する項目のリスト

      • total_count: 一致する項目の総数

      • limit: 1ページあたりの項目数

      • offset: 現在のオフセット

設定項目
説明

query

検索クエリ(設定例:quarterly report)

file_extensions

フィルタリングするファイル拡張子のリスト(例:['pdf', 'docx'])

type

検索対象アイテムの種類:'file'、'folder'、または'web_link'

ancestor_folder_ids

検索対象となるフォルダIDのリスト(設定例:123456789)

limit

返されるアイテムの最大数(最大200個)(設定例:10)

offset

返されるアイテムの開始オフセット(設定例:10)

  • ツール概要

    • Boxのファイルまたはフォルダの共有リンクを作成します。

  • 戻り値(出力):

    • 共有リンクのURLと設定を含む辞書。

設定項目
説明

item_type

アイテムの種類( 'file' または 'folder')

item_id

アイテムのID(設定例:123456789)

access

アクセスレベル ( 'open','company', 'collaborators')

password

共有リンクのパスワード(設定例:secret123)

unshared_at

リンクの有効期限を示すISO 8601タイムスタンプ(設定例:2025-12-31T23:59:59Z)

can_download

共有リンクでのダウンロードを許可するか (許可する=True, 許可しない=False)

  • ツール概要

    • ファイルまたはフォルダの共有リンク情報を取得します。

  • 戻り値(出力):

    • 共有リンクのURLと設定を含む辞書、またはリンクが存在しない場合はメッセージ。

設定項目
説明

can_download

共有リンクでのダウンロードを許可するか (許可する=True, 許可しない=False)

item_type

アイテムの種類( 'file' または 'folder')

item_id

アイテムのID(設定例:123456789)

  • ツール概要

    • ファイルまたはフォルダから共有リンクを削除します。

  • 戻り値(出力):

    • 削除が成功したことを示す辞書。

設定項目
説明

item_type

アイテムの種類( 'file' または 'folder')

item_id

アイテムのID(設定例:123456789)

CLIP MCP Server

概要

CLIP(関税法令情報ポータル:관세법령정보포털 / Korea Customs Law Information Portal)のMCP Serverです。HSコード分類に関する情報の検索・取得を行えます。

ツール名:Search Product

  • ツール概要

    • CLIPの統合検索(통합검색)で製品を検索します。品目分類の国内事例(품목분류 국내사례)を返します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • cases: 見つかった分類事例のリスト

      • total_count: 結果件数

設定項目
説明

query

検索クエリ。

ツール名:Get Classification Case

  • ツール概要

    • 特定の分類事例の詳細情報を取得します。 ※ search_product の結果に含まれる rrdc_no を使用してください(reference_number ではありません)。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 事例の詳細を含む dict

      • reference_number: 参照番号(참조번호)

      • effective_date: 施行日(시행일자)

      • issuing_agency: 施行機関(시행기관)

      • hs_code: 決定税番(결정세번)

      • product_name: 品名(품명)

      • product_description: 物品説明(물품설명)

      • decision_reason: 決定事由(결정사유)

設定項目
説明

rrdc_no

分類事例の識別番号。search_product の結果に含まれる rrdc_no を指定します。

ツール名:Get Hs Commentary

  • ツール概要

    • CLIPからHSコードの解説書(해설서)を取得します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • hs_code: 照会したHSコード

      • tab_type: 使用したタブ種別

      • heading_notes: 号(号)の解説(호 해설)

      • chapter_notes: 類(類)の解説(류 해설)

設定項目
説明

hs_code

4桁のHSコード。

tab_type

解説の種別。デフォルトは '3'(류해설=類の解説)。

ツール名:Get Tariff Rates

  • ツール概要

    • 特定のHSコードの関税率表(관세율표)を取得します。 以下の税率を含みます:

      • 基本税率(기본세율)

      • FTA協定税率(협정세율)

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • rates: 関税率エントリのリスト

      • hs_code: 照会したHSコード

設定項目
説明

hs_code

6桁のHSコード(ドットなし)。

ツール名:Classify Product

  • ツール概要

    • 製品を分類し、HSコードのレコメンドを取得する一連のワークフローを実行します。 このツールは以下を行います:

      1. 類似の分類事例を検索する

      2. 各事例の詳細情報を取得する(물품설명=物品説明、결정사유=決定事由)

      3. 関連するHSコードの解説を取得する(류해설=類の解説、호해설=号の解説)

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • product_name: 検索した製品名

      • product_description: 製品説明

      • cases: 分類事例の詳細リスト(物品説明・決定事由を含む)

      • related_hs_codes: 抽出されたHSコードのリスト

      • commentaries: HSコード別の解説書(류해설・호해설)

      • case_count: 検索された事例数

設定項目
説明

product_name

製品名。

product_description

製品の詳細説明(任意。指定を推奨)。

DB Connector

概要

スキーマ参照(イントロスペクション)とクエリ実行を行うデータベース操作用のMCP Serverです。db_list_tables、db_table_stat、db_query(読み取り専用)、db_exec(書き込み操作)を提供します。PostgreSQL、Azure Synapse Analytics、SQL Server に対応しています。

設定項目
説明

DB_CONNECTION_STRING

接続先データベースの接続文字列。

ツール名:Db List Tables

  • ツール概要

    • データベース内の利用可能なすべてのテーブルを一覧表示します。 接続中のデータベースにどのテーブルがあるかを簡単に把握できます。データのクエリや特定テーブルの統計取得の前に使用してください。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • {"success": true, "tables": ["events", "users", "logs"]}

  • 使用例

    • db_list_tables()

設定項目(引数)はありません。

ツール名:Db Table Stat

  • ツール概要

    • 特定のテーブルの詳細な統計情報を取得します。 テーブルに関する包括的な情報を返します:

      • row_count: 総行数

      • columns: 列情報のリスト(name、type、nullable、null_count、distinct_count、top_values)

      この情報は、LLMが正確なSQLを記述する際に役立ちます(利用可能な列とデータ型の把握、WHERE条件のためのデータ分布(top_values)、適切なNULL処理のためのnullable列、distinct数に基づく結合キー候補の特定)。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • {"success": true, "table": "events", "row_count": 23510, "columns": [...]}

  • 使用例

    • db_table_stat(table="events")

設定項目
説明

table

統計を取得する対象テーブル名。

ツール名:Db Query

  • ツール概要

    • SQLクエリを実行し、結果の行を返します。 主に SELECT クエリで使用します。列、制限された行、追加の行が存在するかどうかを返します(サーバーは limit+1 行を取得して追加結果の有無を判定します)。 このツールは読み取り専用トランザクションでクエリを実行し、INSERT/UPDATE/DELETE/DROP を防止します。書き込み操作には db_exec を使用してください。 クエリはデータベースユーザーの権限に従います。has_more で制限を超える行があるかを確認できます。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • {"success": true, "columns": ["id", "name"], "rows": [[1, "alice"], [2, "bob"]], "has_more": true}

    • エラーケース:

      • 不正なSQL構文: INVALID_SQL

      • テーブルが見つからない: TABLE_NOT_FOUND

      • 列が見つからない: COLUMN_NOT_FOUND

      • 書き込み操作の試行: QUERY_EXECUTION_ERROR(db_exec を使用してください)

      • 権限不足: QUERY_EXECUTION_ERROR

      • クエリのタイムアウト(30秒): QUERY_EXECUTION_ERROR

      • limitの範囲外: LIMIT_OUT_OF_RANGE

  • 使用例

    • db_query(sql="SELECT * FROM users WHERE active=true ORDER BY id DESC")

    • db_query(sql="SELECT id, name FROM users", limit=50)

設定項目
説明

sql

実行するSQLクエリ(SELECT文)。

limit

返される最大行数。

ツール名:Db Exec

  • ツール概要

    • SQLコマンドを実行し、影響を受けた行数を返します。 主に INSERT、UPDATE、DELETE 操作で使用します。操作によって影響を受けた行数を返します。 DDL操作(CREATE、DROP、ALTER)はデータベースユーザーの権限に従います。すべての操作はトランザクションでラップされます。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • {"success": true, "rows_affected": 1}

    • エラーケース:

      • 不正なSQL構文: INVALID_SQL

      • テーブル/列が見つからない: TABLE_NOT_FOUND / COLUMN_NOT_FOUND

      • 制約違反: QUERY_EXECUTION_ERROR

      • 権限不足: QUERY_EXECUTION_ERROR

      • コマンドのタイムアウト(30秒): QUERY_EXECUTION_ERROR

  • 使用例

    • db_exec(sql="INSERT INTO events (level, message) VALUES ('info', 'test')")

    • db_exec(sql="UPDATE events SET level='critical' WHERE id=100")

    • db_exec(sql="DELETE FROM events WHERE id < 100")

設定項目
説明

sql

実行するSQLコマンド(INSERT/UPDATE/DELETE/DDL など)。

ツール名:Db Import Data

  • ツール概要

    • Excel、CSV、JSON 形式のデータをデータベーステーブルにインポートします。 提供されたデータに基づいて新しいテーブルを作成(または既存テーブルを変更)します。列の型はデータから自動推論されます:

      • 整数列 → SMALLINT/INTEGER/BIGINT(範囲に応じて)

      • 浮動小数点列 → DOUBLE PRECISION

      • ブール列 → BOOLEAN

      • 日時列 → TIMESTAMP

      • 文字列列 → VARCHAR(255) または TEXT(長さに応じて)

      データソース(data パラメータ)の指定方法:tmpfs:// パス、https:// URL、Base64文字列(CSV/Excel)、JSON文字列(JSON形式)。 データ形式要件:CSV はヘッダー行付き、Excel は .xlsx(最初のシートをインポート)、JSON はオブジェクトの配列。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • {"success": true, "table_name": "my_table", "rows_imported": 100, "columns": [...], "column_types": {...}}

    • エラーケース:

      • 不正なデータ形式: INVALID_SQL

      • テーブルが既に存在(if_exists='fail'): QUERY_EXECUTION_ERROR

      • 空データ: QUERY_EXECUTION_ERROR

      • インポートのタイムアウト(60秒): QUERY_EXECUTION_ERROR

  • 使用例

    • db_import_data(data="tmpfs://20241216123456/data.xlsx", format="excel", table_name="sales_data")

    • db_import_data(data="https://example.com/data.csv", format="csv", table_name="external_data")

    • db_import_data(data='[{"name": "Alice", "age": 30}, {"name": "Bob", "age": 25}]', format="json", table_name="users")

設定項目
説明

data

インポートするデータ。tmpfs:// パス、https:// URL、Base64文字列、JSON文字列で指定します。

format

データ形式(excel/csv/json)。

table_name

インポート先のテーブル名。

if_exists

同名テーブルが存在する場合の挙動(例:'fail' で失敗)。

ツール名:Db Chart

  • ツール概要

    • SQLクエリ結果からグラフを生成し、PNG画像として保存します。 SQLクエリを実行して結果をグラフとして可視化し、tmpfs(S3ストレージ)にアップロードします。生成されたグラフのtmpfsパスを返します。 対応グラフ種別:bar(縦棒)、horizontal_bar(横棒。長いカテゴリ名向け)、pie(円。割合表示向け、最大10スライス)、line(折れ線。時系列の傾向向け)、histogram(ヒストグラム。数値分布向け)。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • {"success": true, "chart_path": "tmpfs://20250116123456/db_chart_abc123.png", "chart_type": "bar", "title": "Employees by Department", "row_count": 15}

    • エラーケース:

      • 不正なSQL構文: INVALID_SQL

      • 列が見つからない: COLUMN_NOT_FOUND

      • データが返らない: QUERY_EXECUTION_ERROR

      • グラフ生成のタイムアウト(60秒): QUERY_EXECUTION_ERROR

  • 使用例

    • db_chart(sql="SELECT department, COUNT(*) as count FROM employees GROUP BY department ORDER BY count DESC LIMIT 10", chart_type="bar", x_column="department", y_column="count", title="Top 10 Departments by Employee Count")

    • db_chart(sql="SELECT salary_type, SUM(salary) as total FROM employees GROUP BY salary_type", chart_type="pie", x_column="salary_type", y_column="total", title="Total Salary by Type")

設定項目
説明

sql

グラフ化するデータを取得するSQLクエリ。

chart_type

グラフ種別(bar/horizontal_bar/pie/line/histogram)。

x_column

X軸に使用する列名。

y_column

Y軸に使用する列名。

title

グラフのタイトル。

x_label

X軸のラベル(任意)。

y_label

Y軸のラベル(任意)。

DOCX Template MCP Server

概要

エージェントがDocxテンプレートとやり取りできるようにする、DocxテンプレートAPI用MCPサーバー

ツール名:Get Docx Template Parameters

  • ツール概要

    • docxファイル(ファイルパス)の全パラメータ情報を取得する

  • 利用例

    • 「会社の方針」に関するすべての文書を探す

    • 特定のハッシュタグが付けられた文書を検索する

    • 特定の条件に一致する文書を見つける

  • 入出力(引数と戻り値)

    • 引数(入力):

      • template_path (str): docx テンプレートファイルのパス

    • 戻り値(出力):

      • str: パラメータ情報およびその例示

ツール名:Generate Docx From Template

  • ツール概要

    • テンプレートパスからパラメータ付きでdocxファイルを生成する

  • 利用例

    • 「会社の方針」に関するすべての文書を探す

    • 特定のハッシュタグが付けられた文書を検索する

    • 特定の条件に一致する文書を見つける

  • 入出力(引数と戻り値)

    • 引数(入力):

      • template_path (str): docxテンプレートファイルのパス

      • output_file_name (str): 出力docxファイル名。末尾は.docxでなければならない

      • parameters (dict[str, Any]): docxテンプレートのパラメータ。この辞書のキーとget_docx_template_parametersの出力に対応している必要がある。

    • 戻り値(出力):

      • str: 生成されたdocxファイルの事前署名済みURL。

設定値

template_path

docxテンプレートファイルのパス

output_file_name

出力docxファイル名。末尾は.docxでなければならない

parameters

docxテンプレートのパラメータ。この辞書のキーとはget_docx_template_parametersの出力に対応している必要がある。

ツール名:Generate Excel From Template

  • ツール概要

    • テンプレートに一連の操作を適用して Excel ファイルを生成する。

  • 入出力(引数と戻り値)

    • 引数(入力):

      • template_path (str): Excel テンプレートファイルのパス(必須)

      • output_file_name (str): 出力する Excel ファイル名(.excel で終わっている必要があります・必須)

      • operations (dict[str, Any]): Excel テンプレートに対して行う操作(必須)

    • 戻り値(出力):

      • str: 生成されたdocxファイルの事前署名済みURL。

設定項目
説明

template_path

Excel テンプレートファイルのパス(必須)

output_file_name

出力する Excel ファイル名(.excel で終わっている必要があります・必須)

operations

Excel テンプレートに対して行う操作(必須)

Fetch

概要

URLからWebコンテンツを取得し、HTMLをMarkdownに変換するMCP Serverです。APIキーなしで、AgentがWebページを取得・読み取りできるようにします。

ツール名:fetch

  • ツール概要

    • URLからインターネット上の情報を取得し、オプションでその内容をMarkdownとして抽出します。 Webコンテンツを取得して本文を抽出し、HTMLを読みやすいMarkdown形式に変換します。大きなページは start_index パラメータでページネーションできます。 最新の情報を取得し、ユーザーにその旨を伝えることができます。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 以下を含む dict

      • content: 取得したコンテンツ(Markdownまたは生HTML)

      • url: リダイレクト後の最終URL

      • content_type: レスポンスのMIMEタイプ

      • total_length: 抽出されたコンテンツの総文字数

      • start_index: 使用された start_index

      • is_truncated: コンテンツが切り詰められたかどうか

      • next_start_index: 次回リクエストで使用するインデックス(切り詰め時)

      • hint: 継続取得のためのヒント(切り詰め時)

  • 注意事項

    • デフォルトでは robots.txt の制限を尊重します。

    • コンテンツはHTMLからMarkdownへ自動変換されます。

    • 大きなページの場合は start_index を使ってページ送りしてください。

設定項目
説明

url

コンテンツを取得するURL。

max_length

レスポンスとして取得する文字数の最大値(デフォルト5000)。

start_index

この文字インデックス以降のコンテンツを取得します(デフォルト0)。必要なデータのみをContextに含めたい場合に有効です。

raw

MarkdownではなくWebページの実際のHTMLコンテンツを取得します(デフォルトFalse)。

ignore_robots_txt

robots.txt のチェックをスキップします(デフォルトFalse)。

Image Creation MCP Server

概要

SERVERLESS API または OpenAI API を使用して、AI画像を生成する MCP サーバー。 生成された画像はAlliのプロジェクト内のファイルストレージに自動的にアップロードされ、シームレスな画像アクセスを実現します。

設定項目
説明

PROVIDER

画像生成のプロバイダータイプ(SERVERLESS または OPENAI)

API_KEY

選択したプロバイダーの API キー (SERVERLESS API キーまたは OpenAI API キー)

ENDPOINT

プロバイダーエンドポイント (SERVERLESS エンドポイント ID または OpenAI ベース URL (https://api.openai.com/v1 など))

MODEL

モデル名(dall-e-3 などの OpenAI では必須ですが、SERVERLESS の場合は必要ありません)

ツール名:Create Image

  • ツール概要

    • SERVERLESS API または OpenAI API を使用して画像を作成し、Alli にアップロードします。このツールは以下の処理を行います。

      1. SERVERLESS API または OpenAI API に画像生成リクエストを送信します。

      2. 完了ステータスをポーリングします。

      3. 生成された画像(base64 形式)をダウンロードします。

      4. upload_media API を使用して、Alli にアップロードします。

      5. 画像にアクセスするためのメディア URL を返します。

  • 入出力(引数と戻り値)

    • 引数(入力):

      • template_path (str): docxテンプレートファイルのパス

      • output_file_name (str): 出力docxファイル名。末尾は.docxでなければならない

      • parameters (dict[str, Any]): docxテンプレートのパラメータ。この辞書のキーとget_docx_template_parametersの出力に対応している必要がある。

    • 戻り値(出力):

      • str: 生成されたdocxファイルの事前署名済みURL。

  • 入力例

    • シンプルな画像: create_image("月明かりの下を歩く黒猫")

    • 詳細な画像: create_image("ゴールデンレトリバーのリアルなポートレート", size="1024x1024", quality="high", style="vivid", response_format="b64_json", num_inference_steps=50)

設定項目
説明

prompt

生成する画像を説明するテキストプロンプトです。英語で記述する必要があります。画質を向上させるために、詳細かつ具体的な説明を記入してください。アートスタイル、照明、構図、色、雰囲気、技術的な詳細などを具体的に指定してください。

例:「太陽の光が差し込む庭に座るゴールデンレトリバーの写実的なポートレート。柔らかな自然光、浅い被写界深度、温かみのあるゴールデンアワーの雰囲気、プロフェッショナルな撮影スタイル」

size

生成する画像のサイズ。次のいずれかを指定する必要があります: 256x256、512x512、1024x1024、1536x1024、1024x1536、1792x1024、1024x1792 (デフォルト)。 OpenAI APIでのみ使用されます。

quality

生成する画像の品質。以下のいずれかを指定する必要があります:high、medium、low、hd、standard(デフォルト)。 OpenAI API でのみ使用されます。

style

生成する画像のスタイル。以下のいずれかを指定する必要があります:vivid、natural(デフォルト)。 OpenAI API でのみ使用されます。

response_format

生成する画像のフォーマット。以下のいずれかを指定する必要があります:url、b64_json(デフォルト)。 OpenAI API でのみ使用されます。

num_inference_steps

画像生成の推論ステップ数(デフォルト)。 SERVERLESS API でのみ使用されます。

OneDrive

概要

OAuth認証によるMicrosoft OneDrive API連携のMCP Serverです。Microsoft Graph API を介して、ファイル・フォルダの管理、共有、検索、コラボレーション機能を利用できます。

設定項目
説明

ONEDRIVE_OAUTH

OneDrive連携のためのOAuth認証情報。

ツール名:Onedrive Upload File

  • ツール概要

    • tmpfs 上のファイルを OneDrive にアップロードします。

  • 入出力(引数と戻り値)

    • 戻り値(出力): アップロードされたファイル情報(ID、名前、サイズ、作成日時など)を含む Dict

  • 使用例

    • onedrive_upload_file("tmpfs://20240101120000/hello.txt", "hello.txt", "root")

    • onedrive_upload_file("tmpfs://20240101120000/file.txt", "file.txt", "FOLDER_ID")

設定項目
説明

tmpfs_path

アップロードするファイルへのtmpfsパス。

file_name

OneDrive上でのファイル名。

parent_folder_id

アップロード先のフォルダID(ルートの場合は "root")。

ツール名:Onedrive Download File

  • ツール概要

    • OneDrive のファイルを tmpfs にダウンロードします。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 以下を含む Dict

      • tmpfs_path: ファイルが保存された tmpfs パス

      • filename: 元のファイル名

      • file_size_bytes: ファイルサイズ(バイト)

      • metadata: ファイル情報(id、name、size など)

  • 使用例

    • onedrive_download_file("ITEM_ID")

設定項目
説明

item_id

ダウンロードするアイテムのID。

ツール名:Onedrive Update File

  • ツール概要

    • tmpfs を使用して、OneDrive 上のファイルの内容を更新します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 更新されたファイル情報を含む Dict

  • 使用例

    • onedrive_update_file("ITEM_ID", "tmpfs://20240101120000/updated_file.txt")

設定項目
説明

item_id

更新するアイテムのID。

tmpfs_path

更新後の内容を持つファイルへのtmpfsパス。

ツール名:Onedrive Delete Item

  • ツール概要

    • OneDrive からファイルまたはフォルダを削除します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 削除の成功を確認する Dict

  • 使用例

    • onedrive_delete_item("ITEM_ID")

設定項目
説明

item_id

削除するアイテムのID。

ツール名:Onedrive Get Item Info

  • ツール概要

    • ファイルまたはフォルダの詳細情報を取得します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): アイテムのメタデータ(ID、名前、サイズ、作成/更新日、親フォルダ)を含む Dict

  • 使用例

    • onedrive_get_item_info("ITEM_ID")

設定項目
説明

item_id

情報を取得するアイテムのID。

ツール名:Onedrive Copy Item

  • ツール概要

    • ファイルまたはフォルダを別のフォルダにコピーします。 ※ コピー操作は非同期で実行され、モニターURLを返します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): コピー操作のステータスとモニターURLを含む Dict

  • 使用例

    • onedrive_copy_item("ITEM_ID", "DEST_FOLDER_ID")

    • onedrive_copy_item("ITEM_ID", "DEST_FOLDER_ID", "copy_of_file.txt")

設定項目
説明

item_id

コピーするアイテムのID。

parent_folder_id

コピー先のフォルダID。

new_name

コピー後の新しい名前(任意)。

ツール名:Onedrive Move Item

  • ツール概要

    • ファイルまたはフォルダを別のフォルダに移動します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 移動されたアイテム情報を含む Dict

  • 使用例

    • onedrive_move_item("ITEM_ID", "DEST_FOLDER_ID")

    • onedrive_move_item("ITEM_ID", "DEST_FOLDER_ID", "renamed_file.txt")

設定項目
説明

item_id

移動するアイテムのID。

parent_folder_id

移動先のフォルダID。

new_name

移動後の新しい名前(任意)。

ツール名:Onedrive Rename Item

  • ツール概要

    • ファイルまたはフォルダの名前を変更します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 名前変更されたアイテム情報を含む Dict

  • 使用例

    • onedrive_rename_item("ITEM_ID", "new_name.txt")

設定項目
説明

item_id

名前変更するアイテムのID。

new_name

新しい名前。

ツール名:Onedrive Create Folder

  • ツール概要

    • OneDrive に新しいフォルダを作成します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 作成されたフォルダ情報(IDと名前)を含む Dict

  • 使用例

    • onedrive_create_folder("New Folder")

    • onedrive_create_folder("Subfolder", "PARENT_FOLDER_ID")

設定項目
説明

folder_name

作成するフォルダ名。

parent_folder_id

親フォルダのID(任意。未指定でルート)。

ツール名:Onedrive List Folder Items

  • ツール概要

    • フォルダ内のアイテムを一覧表示します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 以下を含む Dict

      • entries: ファイルとフォルダのリスト

      • total_count: 返されたアイテム数

      • next_link: 次ページのURL(ある場合)

  • 使用例

    • onedrive_list_folder_items()

    • onedrive_list_folder_items("FOLDER_ID")

    • onedrive_list_folder_items("FOLDER_ID", limit=50)

設定項目
説明

folder_id

一覧表示するフォルダのID(未指定でルート)。

limit

返される最大アイテム数。

ツール名:Onedrive Get Folder Info

  • ツール概要

    • フォルダの詳細情報を取得します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): フォルダのメタデータ(ID、名前、サイズ、アイテム数、親フォルダ)を含む Dict

  • 使用例

    • onedrive_get_folder_info("FOLDER_ID")

    • onedrive_get_folder_info("root")

設定項目
説明

folder_id

情報を取得するフォルダのID。

ツール名:Onedrive Get Drive Info

  • ツール概要

    • ストレージ容量(クォータ)を含む、ユーザーのOneDriveに関する情報を取得します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): ドライブ情報(ID、名前、ドライブ種別、クォータ詳細)を含む Dict

  • 使用例

    • onedrive_get_drive_info()

設定項目(引数)はありません。

  • ツール概要

    • OneDrive内のファイルとフォルダを検索します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 以下を含む Dict

      • entries: 一致したアイテムのリスト

      • total_count: 返された結果数

      • next_link: 次ページのURL(ある場合)

  • 使用例

    • onedrive_search("quarterly report")

    • onedrive_search("budget", limit=50)

設定項目
説明

query

検索クエリ。

limit

返される最大結果数。

ツール名:Onedrive Search In Folder

  • ツール概要

    • 特定のフォルダ内でファイルとフォルダを検索します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 以下を含む Dict

      • entries: 一致したアイテムのリスト

      • total_count: 返された結果数

      • next_link: 次ページのURL(ある場合)

  • 使用例

    • onedrive_search_in_folder("FOLDER_ID", "report")

設定項目
説明

folder_id

検索対象のフォルダID。

query

検索クエリ。

limit

返される最大結果数。

ツール名:Onedrive Get Recent Files

  • ツール概要

    • 最近アクセスしたファイルを取得します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 以下を含む Dict

      • entries: 最近のファイルのリスト

      • total_count: 返された結果数

  • 使用例

    • onedrive_get_recent_files()

    • onedrive_get_recent_files(limit=50)

設定項目
説明

limit

返される最大結果数。

ツール名:Onedrive Get Shared With Me

  • ツール概要

    • 現在のユーザーと共有されているファイルを取得します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 以下を含む Dict

      • entries: 共有ファイルのリスト

      • total_count: 返された結果数

  • 使用例

    • onedrive_get_shared_with_me()

設定項目
説明

limit

返される最大結果数。

  • ツール概要

    • ファイルまたはフォルダの共有リンクを作成します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 共有リンクURLと設定を含む Dict

  • 使用例

    • onedrive_create_sharing_link("ITEM_ID")(公開・閲覧のみ)

    • onedrive_create_sharing_link("ITEM_ID", link_type="edit")(編集可)

    • onedrive_create_sharing_link("ITEM_ID", scope="organization")(組織内限定)

    • onedrive_create_sharing_link("ITEM_ID", password="secret123")(パスワード保護)

    • onedrive_create_sharing_link("ITEM_ID", expiration_datetime="2024-12-31T23:59:59Z")(期限付き)

設定項目
説明

item_id

共有リンクを作成するアイテムのID。

link_type

リンクの種類(例:'view' 閲覧のみ、'edit' 編集可)。

scope

公開範囲(例:'anonymous' 公開、'organization' 組織内限定)。

password

リンクに設定するパスワード(任意)。

expiration_datetime

リンクの有効期限(ISO形式、任意)。

  • ツール概要

    • ファイルまたはフォルダの共有リンク情報を取得します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 共有権限を含む Dict(リンクが無い場合はメッセージ)

  • 使用例

    • onedrive_get_sharing_links("ITEM_ID")

設定項目
説明

item_id

共有リンクを取得するアイテムのID。

  • ツール概要

    • ファイルまたはフォルダから共有権限を削除します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 削除の成功を確認する Dict

  • 使用例

    • onedrive_delete_sharing_link("ITEM_ID", "PERMISSION_ID")

設定項目
説明

item_id

対象アイテムのID。

permission_id

削除する権限のID。

ツール名:Onedrive Invite User

  • ツール概要

    • ファイルまたはフォルダへのアクセス権をユーザーに招待します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 招待情報を含む Dict

  • 使用例

    • onedrive_invite_user("ITEM_ID", "user@example.com")(読み取り権限)

    • onedrive_invite_user("ITEM_ID", "user@example.com", roles=["write"])(書き込み権限)

    • onedrive_invite_user("ITEM_ID", "user@example.com", message="Please review this document")(メッセージ付き)

設定項目
説明

item_id

招待対象のアイテムのID。

email

招待するユーザーのメールアドレス。

roles

付与する権限のリスト(例:["read"]、["write"])。

send_invitation

招待メールを送信するかどうか。

message

招待に添えるメッセージ(任意)。

ツール名:Onedrive List Permissions

  • ツール概要

    • ファイルまたはフォルダのすべての権限を一覧表示します。

  • 入出力(引数と戻り値)

    • 戻り値(出力): 以下を含む Dict

      • permissions: 権限のリスト

      • total_count: 権限の数

  • 使用例

    • onedrive_list_permissions("ITEM_ID")

設定項目
説明

item_id

権限を一覧表示するアイテムのID。

OpenAI Tools

概要

音声認識 (Whisper)、音声翻訳、画像生成 (DALL-E) などの OpenAI API を提供する MCP サーバーです。

設定項目
説明

OPENAI_API_KEY

OpenAI APIキー。環境変数を参照するには「ENV_VARIABLE_NAME」を使用します(例:ENV_MY_OPENAI_KEY)

ALLI_API_KEY

AlliのAPIキー

ALLI_API_URL

AlliのAPI接続URL

ALLI_AGENT_EMAIL

Alliのアカウントemailアドレス

ALLI_PROJECT_ID

AlliのプロジェクトID

ツール名:Transcribe Audio

  • ツール概要

    • OpenAI Whisper API を使用して音声ファイルをテキストに変換します。テキストの説明からAI生成画像を作成し、一時ストレージに保存します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • images: 'tmpfs_path' とオプションで 'revised_prompt' を持つ画像オブジェクトのリスト

        • model: 生成に使用したモデル

        • size: 画像のサイズ

        • count: 生成した画像の数

  • 入力例

    • generate_image("A serene Japanese garden at sunset", model="dall-e-3", quality="hd") -> { "images": [{"tmpfs_path": "tmpfs://20250115123456/A_serene_Japanese_garden_at_sunset_1.png", "revised_prompt": "..."}], "model": "dall-e-3", "size": "1024x1024", "count": 1 }

設定項目
説明

file_path

文字起こしする音声ファイル。HTTP/HTTPS URL、tmpfsパス(tmpfs://...)、またはファイル名で指定できます。GPT-4oモデル:wav、mp3のみ(最大10MB)。Whisper:flac、m4a、mp3、mp4、mpeg、mpga、oga、ogg、wav、webm(最大25MB)

model

使用するモデル: 'gpt-4o-audio-preview' (音声付き GPT-4o)、 'gpt-4o-mini-audio-preview' (小さい GPT-4o 音声)、 'whisper-1' (標準 Whisper)

language

オプション:ISO-639-1言語コード(例:'en'、'ko'、'ja'、'es'、'fr'、'de'、'zh')。指定されていない場合、Whisperは言語を自動検出します。これは、未知の音声の場合に推奨されます。事前に言語がわかっている場合は、指定することで精度が向上します。

prompt

モデルのスタイルをガイドするオプションのテキスト。名前、専門用語、または文脈の正しいスペルを含めることができます。例:「これは、Acme Inc.の製品発表に関する、CEOのスミス博士との会議です。」

temperature

サンプリングのTemperature(0~1)。値が大きいほどランダム性が増す。

ツール名:Text To Speech

  • ツール概要

    • OpenAI TTS API を使用してテキストを音声に変換し、tmpfs に保存します。複数の音声と形式で入力されたテキストから自然な音声を作成します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • tmpfs_path: tmpfs 内の生成された音声ファイルへのパス

        • voice: 生成に使用した音声

        • model: 使用したモデル

        • format: 音声形式

        • duration_estimate: テキストの長さに基づく推定再生時間

  • 入力例

    • text_to_speech("Hello world!", voice="nova") -> { "tmpfs_path": "tmpfs://20250115123456/speech_nova_1.mp3", "voice": "nova", "model": "tts-1", "format": "mp3", "duration_estimate": "~2 seconds" }

設定項目
説明

text

音声に変換するテキスト。最大4096文字。

voice

使用する音声。オプション: 「alloy」「echo」「fable」「onyx」「nova」「shimmer」

model

TTS モデル。「tts-1」(高速、低品質)または「tts-1-hd」(低速、高品質)

speed

話す速度(0.25~4.0)。1.0 が通常の速度です。

response_format

オーディオ形式。オプション: 'mp3'、'opus'、'aac'、'flac'、'wav'、'pcm'

ツール名:Generate Image

  • ツール概要

    • OpenAI DALL-E API を使用してイメージを生成し、tmpfs に保存します。テキストの説明からAI生成画像を作成し、一時ストレージに保存します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • images: 'tmpfs_path' とオプションで 'revised_prompt' を持つ画像オブジェクトのリスト

        • model: 生成に使用したモデル

        • size: 画像のサイズ

        • count: 生成した画像の数

  • 入力例

    • generate_image("A serene Japanese garden at sunset", model="dall-e-3", quality="hd") -> { "images": [{"tmpfs_path": "tmpfs://20250115123456/A_serene_Japanese_garden_at_sunset_1.png", "revised_prompt": "..."}], "model": "dall-e-3", "size": "1024x1024", "count": 1 }

詳細項目
説明

prompt

生成する画像の説明文です。具体的かつ詳細な説明を記述することで、最良の結果が得られます。

model

使用するモデル: 「dall-e-3」(最新、最高品質) または「dall-e-2」(より高速、安価)

size

画像サイズ。DALL-E 3: '1024x1024'、'1024x1792'、'1792x1024'。DALL-E 2: '256x256'、'512x512'、'1024x1024'

quality

画像品質(DALL-E 3 のみ): 「標準」または「HD」(高画質、詳細)

style

画像スタイル(DALL-E 3 のみ): 「鮮明」(ハイパーリアル)または「ナチュラル」(より自然)

n

生成する画像の数(DALL-E 2の場合は1~10、DALL-E 3の場合は1のみ)

Run Python

概要

Python 実行機能を提供するMCPサーバーです。

ツール名:run_python_code

  • ツール概要

    • Python コードを実行し、標準出力、標準エラー出力、戻り値を返すツールです。コードは非同期で実行でき、最終行の値が戻り値として返されます。

      コードは Python 3.12 で実行されます。

      依存関係は PEP 723 スクリプトメタデータで定義できます。例えば、「pydantic」をインストールする場合、スクリプトは以下の形式のコメントで始まる必要があります。

      /// script dependencies = ['pydantic'] /// print('python code here')

SERPER API MCP Server

概要

SERPER API (serper.dev) 用の MCP サーバー。Web、画像、ニュース、動画、ショッピング、場所、学者検索などの包括的な Google 検索機能を提供します。

設定項目
説明

SERPER_API_KEY 

Google 検索サービスにアクセスするためのSERPER API キー

ツール名:Search Web

  • ツール概要

    • SERPER API (Google 検索) を使用してウェブ検索を実行します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • organic: タイトル、リンク、スニペットを含むオーガニック検索結果のリスト

        • knowledgeGraph: ナレッジグラフ情報 (利用可能な場合)

        • answerBox: 回答ボックスの内容 (利用可能な場合)

        • relatedSearches: 関連検索候補

        • searchParameters: 実行された検索に関する情報

  • 入力例

    • search_web("python programming", num=5) -> { "organic": [ {"title": "Python.org", "link": "https://python.org", "snippet": "Official Python website..."}, ... ], "knowledgeGraph": {...}, "answerBox": {...}, "relatedSearches": [{"query": "python tutorial"}, ...] }

設定項目
説明

query

検索クエリ文字列

num

返却される結果の数(デフォルト: 10)

country

国コード(例:「us」、「kr」、「jp」)

location

検索する場所(例:「ニューヨーク、NY」)

locale

ロケールコード (例: 「en」、「ko」、「ja」)

autocorrect

検索クエリの自動補完を有効にする

page

ページ番号(デフォルト:1)

ツール名:Images

  • ツール概要

    • SERPER API を使用して画像を検索します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • images: タイトル、画像URL、画像幅、画像高さ、ソースを含む画像結果のリスト

        • searchParameters: 実行された検索に関する情報

  • 入力例

    • search_images("cute puppies", num=5) -> { "images": [ { "title": "Adorable Puppy", "imageUrl": "https://example.com/puppy.jpg", "imageWidth": 800, "imageHeight": 600, "source": "example.com" }, ... ] }

設定項目
説明

query

検索クエリ文字列

num

返却される結果の数(デフォルト: 10)

country

国コード(例:「us」、「kr」、「jp」)

locale

ロケールコード (例: 「en」、「ko」、「ja」)

autocorrect

検索クエリの自動補完を有効にする

ツール名:News

  • ツール概要

    • SERPER API を使用してニュース記事を検索します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • news: タイトル、リンク、スニペット、日付、ソースを含むニュース記事のリスト

        • searchParameters: 実行された検索に関する情報

  • 入力例

    • search_news("AI breakthrough", tbs="qdr:w") -> { "news": [ { "title": "AIの大きなブレークスルーが発表されました", "link": "https://news.example.com/ai-breakthrough", "snippet": "科学者が発表...", "date": "2日前", "source": "技術ニュース" }, ... ] }

設定項目
詳細設定

query

検索クエリ文字列

num

返却される結果の数(デフォルト: 10)

country

国コード(例:「us」、「kr」、「jp」)

locale

ロケールコード (例: 「en」、「ko」、「ja」)

autocorrect

検索クエリの自動補完を有効にする

tbs

時間ベースの検索(例:過去1日の場合は「qdr:d」、過去1週間の場合は「qdr:w」)

ツール名:Videos

  • ツール概要

    • SERPER API を使用して動画を検索します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • videos: タイトル、リンク、スニペット、画像 URL、再生時間、ソースを含む動画のリスト

        • searchParameters: 実行された検索に関する情報

  • 入力例

    • search_videos("machine learning tutorial") -> { "videos": [ { "title": "ML Tutorial for Beginners", "link": "https://youtube.com/watch?v=...", "snippet": "Learn machine learning basics...", "imageUrl": "https://i.ytimg.com/...", "duration": "15:30", "source": "YouTube" }, ... ] }

設定項目
説明

query

検索クエリ文字列

num

返却される結果の数(デフォルト: 10)

country

国コード(例:「us」、「kr」、「jp」)

locale

ロケールコード (例: 「en」、「ko」、「ja」)

autocorrect

検索クエリの自動補完を有効にする

ツール名:Search Shopping

  • ツール概要

    • SERPER API を使用して、商品とショッピング結果を検索します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • shopping: タイトル、価格、リンク、ソース、評価、レビューを含む商品リスト

        • searchParameters: 実行された検索に関する情報

  • 入力例

    • search_shopping("laptop") -> { "shopping": [ { "title": "Dell XPS 13", "price": "$999.99", "link": "https://shop.example.com/...", "source": "Dell Store", "rating": 4.5, "reviews": 1250 }, ... ] }

設定項目
説明

query

検索クエリ文字列

num

返却される結果の数(デフォルト: 10)

country

国コード(例:「us」、「kr」、「jp」)

locale

ロケールコード (例: 「en」、「ko」、「ja」)

autocorrect

検索クエリの自動補完を有効にする

ツール名:Search Places

  • ツール概要

    • SERPER API (Google マップ) を使用して場所を検索します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • places: タイトル、住所、評価、レビュー、電話番号、営業時間を含む場所のリスト

        • searchParameters: 実行された検索に関する情報

  • 入力例

    • search_places("coffee shop near Seattle") -> { "places": [ { "title": "Starbucks Reserve", "address": "1124 Pike St, Seattle, WA", "rating": 4.3, "reviews": 850, "phone": "+1 206-624-0173", "hours": "Open ⋅ Closes 8 PM" }, ... ] }

設定項目
説明

query

検索クエリ文字列

num

返却される結果の数(デフォルト: 10)

country

国コード(例:「us」、「kr」、「jp」)

locale

ロケールコード (例: 「en」、「ko」、「ja」)

autocorrect

検索クエリの自動補完を有効にする

ツール名:Search Scholar

  • ツール概要

    • SERPER API (Google Scholar) を使用して、学術コンテンツを検索します。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • organic: タイトル、リンク、スニペット、引用情報を含む学術論文のリスト

        • searchParameters: 実行された検索に関する情報

  • 入力例

    • search_scholar("machine learning algorithms") -> { "organic": [ { "title": "Deep Learning for Computer Vision", "link": "https://scholar.google.com/...", "snippet": "This paper presents...", "citedBy": "Cited by 1250", "publication": "Nature Machine Intelligence" }, ... ] }

設定項目
説明

query

検索クエリ文字列

num

返却される結果の数(デフォルト: 10)

country

国コード(例:「us」、「kr」、「jp」)

locale

ロケールコード (例: 「en」、「ko」、「ja」)

autocorrect

検索クエリの自動補完を有効にする

Salesforce MCP Server

概要

Salesforce APIを統合するためのMCP Serverです。 Salesforceデータとメタデータとの自然言語によるインタラクションを可能にします。 オブジェクト検索、スキーマ情報、SOQLクエリ、選択リスト値、リレーションシップ探索、検証ルール、デバッグログ管理が可能です。 必要なツールを選択してください。

ツール名:Search Salesforce Objects

  • ツール概要

    • Salesforce の標準オブジェクトとカスタムオブジェクトを名前のパターンで検索します。

      Salesforce オブジェクト(標準またはカスタム)を、名前のパターンで検索して見つけることができます。 オブジェクトの正確な名前がわからない場合や、関連オブジェクトを見つけたい場合に有効です。

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • Salesforce オブジェクトのフォーマットされたリスト

設定項目
説明

pattern

オブジェクト名に一致する検索パターンを入力(例: 「アカウント」、「注文」)

ツール名:Describe Salesforce Object

  • ツール概要

    • Salesforce オブジェクトのすべてのフィールド、リレーションシップ、フィールドプロパティを含む詳細なスキーマメタデータを取得します。

  • 使用例

    • 「OpportunityLineItem オブジェクトの構造を説明してください」

    • 「Campaign オブジェクトにはどのようなフィールドがありますか?」

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • オブジェクトの詳細なスキーマ情報

      • 引数で指定したオブジェクトの全フィールド、リレーション、およびプロパティを含む構造データ。

設定項目
説明

object_name

オブジェクトの API 名 (例: 'Account'、'Contact'、'Custom_Object__c')

ツール名:Describe Salesforce Object Raw Json

  • ツール概要

    • Salesforce オブジェクトスキーマ全体を生の JSON 形式で取得します。

    • Salesforce からフィルタリングされていない API レスポンスが直接返されます。

    • このツールは、高度な分析のために完全かつ詳細なメタデータが必要な場合や、標準の記述形式に含まれていない特定のメタデータプロパティにアクセスする必要がある場合に有効です。

  • 使用例

    • リードの生の JSON スキーマを取得する

    • アカウントオブジェクトの完全な API レスポンスを表示する

    • Custom_Object__c の完全な JSON メタデータを返す

    • 「商談の完全なメタデータスキーマを JSON 形式で取得したい」

    • 「アカウントの技術的なメタデータの詳細をすべて表示する」

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • Salesforce API からの完全な生の JSON スキーマ

設定項目
説明

object_name

オブジェクトの API 名 (例: 'Account'、'Contact'、'Custom_Object__c')

ツール名:Get Salesforce Picklist Values

  • ツール概要

    • 選択リスト項目からすべての値を取得します。

    • ドロップダウン/選択リスト項目で利用可能なすべてのオプションを返します。

  • 使用例

    • すべてのケースステータスの値を取得する

    • Lead.Source の選択リスト値を表示する

    • Account.Type のすべての値を一覧表示する

    • 「取引先で利用可能な業種オプションは何ですか?」

    • 「商談ステージで使用可能なすべての値を表示する」

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 値のラベル

      • API 名

      • デフォルト値のインジケーター

      • 有効/無効のステータス

      • フィールドの依存関係の制御(存在する場合)

設定項目
説明

object_name

オブジェクトの API 名 (例: 'Case'、'Lead')

field_name

選択リスト項目の API 名 (例: 'Status'、'Source')

ツール名:Describe Salesforce Relationship Fields

  • ツール概要

    • Salesforce オブジェクトのすべてのリレーションフィールド(参照関係、主従関係)を表示します。オブジェクト間の依存関係と接続を理解するために有効です。

  • 使用例

    • 商談のすべての関連オブジェクトを一覧表示する

    • 取引先責任者オブジェクトのリレーションシップを表示する

    • ケースオブジェクトの参照を説明する

    • 「取引先に関連するオブジェクトは何ですか?」

    • 「取引先責任者オブジェクトのすべての参照関係を表示する」

    • 「商談の親子関係は何ですか?」

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 親子関係

      • 参照関係と主従関係の種類

      • 関連オブジェクト名

      • カスケード削除の動作

      • 必要なリレーションシップのステータス

設定項目
説明

object_name

オブジェクトの API 名 (例: 'Opportunity'、'Contact')

ツール名:Get Salesforce Fields By Type

  • ツール概要

    • Salesforce オブジェクトの特定の型のフィールドを取得します。型が指定されていない場合、すべてのフィールドが返されます。

    • データ型でフィールドをフィルタリングできます。特定の種類のフィールドを検索する場合に有効です。

  • 使用例

    • リードのすべての選択リストフィールドを表示する

    • 取引先のすべての参照フィールドを取得する

    • 取引先責任者のすべてのテキストフィールドを一覧表示する

    • 商談のすべてのフィールドを取得する

    • 「イベントオブジェクトのすべての日時フィールドを検索する」

    • 「商談オブジェクトにはどのような通貨フィールドがありますか?」

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • テキストフィールド(文字列)

      • 数値フィールド(倍精度、整数)

      • 日付/時刻フィールド

      • 選択リストフィールド

      • 参照/ルックアップフィールド

      • 数式フィールド

      • その他

設定項目
説明

object_name

オブジェクトのAPI名 (例: 'Lead'、'Account')

field_type

フィールドをフィルタリングするオプションの型 (例: 'picklist'、'reference'、'string')

ツール名:Query Salesforce Records

  • ツール概要

    • SOQL を使用して、フィルタリング、並べ替え、および制限オプションを使用して Salesforce レコードをクエリします。

  • 使用例

    • 今月作成されたすべての取引先を取得する

    • 100,000ドルを超える商談を検索する

    • 優先度の高いケースとその取引先責任者を表示する

    • 「最近作成された5つの取引先を表示する」

    • 「今月成立する50,000ドルを超えるすべての商談を検索する」

    • 「役職が「CEO」の取引先責任者を会社名で並べ替えて一覧表示する」

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • 特定のフィールドの選択

      • オプションの WHERE フィルタリング条件

      • オプションの並べ替え (ORDER BY)

      • 返されるレコード数の制限

設定項目
説明

object_name

クエリを実行するオブジェクトのAPI名 (例: 「取引先」、「商談」)

fields

取得するフィールドのリスト

where_clause

オプションのフィルタリング条件

order_by

オプションの並べ替え条件

limit

返されるレコードの最大数 (デフォルト: 10)

ツール名:Get Salesforce Validation Rules

  • ツール概要

    • 特定の Salesforce オブジェクトの検証ルールを取得します。

  • 使用例

    • リードオブジェクトのすべての検証ルールを取得する

    • 商談オブジェクトの検証ルールを表示する

    • 取引先オブジェクトの有効な検証を一覧表示する

    • 「取引先責任者オブジェクトにはどのような検証ルールが適用されていますか?」

    • 「商談オブジェクトのすべてのデータ品質ルールを表示する」

    • 「取引先レコードの検証条件を一覧表示する」

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • ルール名とステータス(有効/無効)

      • ユーザーに表示されるエラーメッセージ

      • エラーが表示されるフィールド

      • ルールの説明

        • 特定の条件を満たさないレコードの保存を防止し、データ品質を強化します。

設定項目
説明

object_name

オブジェクトの API 名 (例: 「取引先」、「リード」、「商談」)

ツール名:Manage Salesforce Debug Logs

  • ツール概要

    • Salesforce ユーザーのデバッグログを管理します。ログの有効化、無効化、または取得が可能です。

    • 特定のユーザーのデバッグログを管理することで、トラブルシューティングに役立ちます。デバッグログは、コード実行、連携、自動化、その他の Salesforce 機能のトラブルシューティングに必要となります

    • 以下のことが可能です。

      • ログを有効にしてデバッグ情報を取得する

      • トラブルシューティングが完了したらログを無効にする

      • ログを取得して表示し、問題を分析する

      • ログの詳細レベルを設定する

  • 使用例

    • ユーザーのデバッグログを有効にする

      • 'enable' 操作、ユーザー名、およびログレベルを指定します。

    • ユーザーのデバッグログを無効にする

      • 'disable' 操作とユーザー名を指定します。

    • ユーザーのデバッグログを取得する

      • 'retrieve' 操作とユーザー名を指定します。

    • 特定のログを完全な内容で取得する

      • 'retrieve' 操作、ユーザー名、log_id、および include_body=True を指定します。

    • 「admin@example.com のデバッグログを FINEST レベルで有効にする」

    • 「user.name@company.com のデバッグログを無効にする」

    • 「システム管理者の最新のデバッグログを取得する」

    • 「ログ ID 07L000000 のデバッグログの内容を表示する」

  • 入出力(引数と戻り値)

    • 戻り値(出力):

      • NONE

      • ERROR

      • WARN

      • INFO

      • DEBUG FINE

      • FINER

      • FINEST

object_name
オブジェクトの API 名 (例: 「取引先」、「リード」、「商談」)

operation

実行する操作 - 'enable'、'disable'、または 'retrieve'

username

Salesforce ユーザーのユーザー名

log_level

デバッグログのログレベル ('enable' 操作の場合は必須) 有効なオプション 有効なオプションは NONE、ERROR、WARN、INFO、DEBUG FINE、FINER、FINEST

expiration_time

デバッグログ設定の有効期限(分)(オプション、デフォルトは30)

limit

取得するログの最大数(オプション、デフォルトは10)

log_id

取得する特定のログのID(オプション)

include_body

ログの全内容を含めるかどうか(オプション、デフォルトはFalse)

ツール名:Check Salesforce Connection

  • ツール概要

    • Salesforce への接続を確認し、組織の基本情報を返します。

    • このツールは、Salesforce 接続が正常に動作していることを検証し、接続された組織に関する以下の基本情報を返します。接続の問題を診断するための最初のステップとして、このツールをご利用ください。

    • 接続ステータス

    • ユーザー名

    • インスタンス URL

    • 環境タイプ(本番環境/サンドボックス環境)

    • 利用可能なオブジェクト数

  • 使用例

    • 「Salesforce 接続が動作しているかどうかを確認する」

    • 「Salesforce API 接続を確認する」

    • 「Salesforce 組織への接続をテストする」

    • 「Salesforce 接続ステータスを表示する」

Slack MCP Server

概要

Slack API と連携できる MCP サーバーです。Botトークン認証とOAuth 認証のどちらにも対応しており、チャンネルやメッセージ、ユーザー操作など、ワークスペース全体の管理をまとめて行うことができます。

設定項目
説明

SLACK_BOT_TOKEN

Slack のボットが Slack API にアクセスするための認証キーです。 このトークンを使うことで、ボットはメッセージ送信やチャンネル操作など、許可された範囲の動作を実行できます。

SLACK_TEAM_ID

Slack ワークスペースを識別するための ID です。 どのワークスペースに対して操作を行うかを指定するために利用されます。

ツール名:Get Timestamp

  • ツール概要

    • 日付の表現を Unix タイムスタンプに変換します。

  • 使用例

    • すべてのケースステータスの値を取得する

    • Lead.Source の選択リスト値を表示する

    • Account.Type のすべての値を一覧表示する

    • 「取引先で利用可能な業種オプションは何ですか?」

    • 「商談ステージで使用可能なすべての値を表示する」

  • 入出力(引数と戻り値)

    • 引数(入力):

      • expression (str):dateparser が解釈できる日付表現

        • 形式は「NUMBER UNIT TIMEZONE」で、例えば「2 week ago JST」や「1 week ago JST」のように入力します。

    • 戻り値(出力):

      • 以下の要素を含む辞書 ・timestamp (int): 秒単位の Unix タイムスタンプ。解析に失敗した場合は None。 ・error (str): 解析に失敗した場合のエラーメッセージ。成功した場合は None。

設定項目
説明

expression

解析したい日付や時間を表す文字列です。

ツール名:Get Channel Messages

  • ツール概要

    • Slack チャンネルからメッセージを取得します。

  • 入出力(引数と戻り値)

    • 引数(入力):

      • channel_id (str): メッセージを取得したいチャンネルの ID。必須。

      • oldest (int): 取得対象となるメッセージの開始時刻(Unix タイムスタンプ)。必須。

      • from_user_id (str | None): 特定ユーザーのメッセージのみ取得したい場合のユーザー ID。任意。

      • latest (int | None): メッセージを取得する範囲の終了時刻(Unix タイムスタンプ)。任意。

      • time_zone (str | None): メッセージのタイムスタンプに適用するタイムゾーン。任意。デフォルトは "Asia/Seoul"。

      • limit (int, 任意): 取得するメッセージの最大数。デフォルトは 100。

    • 戻り値(出力):

      • メッセージスレッドのリストを含む辞書。各スレッドは複数のメッセージで構成されます。

設定項目
説明

hannel_id

メッセージを取得したいチャンネルの ID。

oldest

取得するメッセージの範囲の開始時刻(Unix タイムスタンプ)。

from_user_id

特定のユーザーに絞ってメッセージを取得したい場合のユーザー ID。任意。

latest

取得するメッセージの範囲の終了時刻(Unix タイムスタンプ)。任意。

time_zone

メッセージのタイムスタンプに適用するタイムゾーン。任意。

limit

取得するメッセージの最大件数。任意。デフォルトは 100。

ツール名:Get Bot User Id

  • ツール概要

    • Bot のユーザー ID を取得します。

ツール名:Get Joined Channels

  • ツール概要

    • ユーザーが参加しているチャンネル一覧を取得します。必要に応じて、検索キーワードでチャンネルを絞り込むこともできます。 ※slack_user_id には、get_bot_user_id ツールで取得した bot_user_id を指定するケースもあります。

  • 入出力(引数と戻り値)

    • 引数(入力):

      • slack_user_id (str):対象ユーザーの ID(例: U0123456789)。

      • search_key (str | None):チャンネル名・トピック・説明文を対象にした検索キーワード。任意。

      • limit (int, optional):返すチャンネルの最大数。デフォルトは 30。

    • 戻り値(出力):

      • 以下の要素を含む辞書を返します。

        • channels (list):参加チャンネルのリスト。各チャンネルには id, name, name_normalized, topic, purpose が含まれます。

        • has_more (bool):取得件数が上限を超えており、まだチャンネルが残っているかどうか。

        • hint (str):さらにチャンネルがある場合に表示されるヒントメッセージ。

設定項目
説明

slack_user_id (str)

対象ユーザーの ID(例: U0123456789)。

search_key (str | None)

チャンネル名・トピック・説明文を対象にした検索キーワード。任意。

limit (int, optional)

返すチャンネルの最大数。デフォルトは 30。

ツール名:Get Channels

  • ツール概要

    • ワークスペース内に存在するすべてのチャンネルを取得します。必要に応じて、検索キーワードでチャンネルを絞り込むこともできます。

  • 入出力(引数と戻り値)

    • 引数(入力):

      • search_key (str | None):チャンネル名・トピック・説明文を対象にした検索キーワード。任意。

      • limit (int, optional):返すチャンネルの最大数。デフォルトは 30。

    • 戻り値(出力):

      • 以下の要素を含む辞書を返します。

        • channels (list):取得したチャンネルのリスト。各チャンネルには id, name, name_normalized, topic, purpose が含まれます。

        • has_more (bool):取得件数が上限を超えており、まだチャンネルが残っているかどうか。

        • hint (str):さらにチャンネルがある場合に表示されるヒントメッセージ。

設定項目
説明

channels (list)

取得したチャンネルのリスト。各チャンネルには id, name, name_normalized, topic, purpose が含まれます。

has_more (bool)

取得件数が上限を超えており、まだチャンネルが残っているかどうか。

hint (str)

さらにチャンネルがある場合に表示されるヒントメッセージ。

ツール名:Get Users

  • ツール概要

    • ワークスペースに所属するユーザー一覧を取得します。必要に応じて、検索キーワードでユーザーを絞り込むこともできます。

  • 入出力(引数と戻り値)

    • 引数(入力):

      • search_key (str | None):ユーザーの本名または表示名を対象とした検索キーワード。任意

      • limit (int, optional):返すユーザーの最大数。デフォルトは 30。

    • 戻り値(出力):

      • 以下の要素を含む辞書を返します。

        • users (list):各ユーザーの id と name を含むユーザーオブジェクトのリスト。

設定項目
内容

search_key (str | None)

ユーザーの本名または表示名を対象とした検索キーワード。任意。

limit (int, optional)

返すユーザーの最大数。デフォルトは 30。

ツール名:Get Channels Cached

  • ツール概要

    • Slack ワークスペース内のチャンネルを取得・検索する機能です。SQLite を使ったキャッシュに対応しており、高速に結果を返します。

  • 入出力(引数と戻り値)

    • 引数(入力):

      • search_key (str | None):ユーザーの本名または表示名を対象とした検索キーワード。任意

      • limit (int, optional):返すユーザーの最大数。デフォルトは 30。

    • 戻り値(出力):

      • 以下の要素を含む辞書を返します。

  • 利用例

    • await get_channels_cached(search="general")

    • await get_channels_cached(search="dev", limit=100)

    • await get_channels_cached(from_=0, limit=50) # 最初の50件を取得

設定項目
内容

search

チャンネル名または説明文に対する検索語(大文字・小文字を区別しない)。

from

ページネーションの開始位置(0 から始まる)。デフォルトは 0。

limit

取得するチャンネルの最大数。デフォルト 50、最大 200。

ツール名:Send Message

  • ツール概要

    • Slack のチャンネルにメッセージを送信します。スレッド返信にも対応しています。

  • 入出力(引数と戻り値)

    • 引数(入力):

      • channel:送信先チャンネルの ID(例: C1234567890)またはチャンネル名(例: #general)。 text:送信するメッセージ本文。

      • thread_ts:スレッドとして返信する場合に指定する親メッセージのタイムスタンプ。任意。

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • メッセージの詳細

        • ステータス

  • 利用例

    • await send_message("#general", "Hello world!") { "message": { "ts": "1234567890.123456", "channel": "C1234567890", "text": "Hello world!" }, "success": true }

設定項目
内容

channel

送信先チャンネルの IDまたはチャンネル名。送信先チャンネルの ID(例: C1234567890

text

送信するメッセージ本文。

thread_ts

スレッドとして返信する場合に指定する親メッセージのタイムスタンプ。任意。

ツール名:Get Messages Cached

  • ツール概要

    • Slack チャンネルからメッセージを取得する機能です。日時フィルタリングや SQLite キャッシュを活用し、効率よくメッセージを取得できます。

  • 入出力(引数と戻り値)

    • 引数(入力):

      • channel:取得対象となるチャンネルの ID(例: C1234567890)またはチャンネル名(例: #general)。

      • limit:取得する最大メッセージ数。デフォルトは 50、最大 1000。

      • oldest:取得範囲の開始日時(YYYY-MM-DD HH:MM:SS 形式)。この日時以降のメッセージを取得します。

      • latest:取得範囲の終了日時(YYYY-MM-DD HH:MM:SS 形式)。この日時までのメッセージを取得します。

      • timezone:日時の解釈に使用するタイムゾーン。指定がない場合はデフォルト設定が使用されます。

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • メッセージ一覧

        • 取得メタデータ

        • キャッシュ情報

  • 利用例

    • await send_message("#general", "Hello world!") { "message": { "ts": "1234567890.123456", "channel": "C1234567890", "text": "Hello world!" }, "success": true

設定項目
説明

channel

取得対象となるチャンネルの IDまたはチャンネル名。例: C1234567890)

limit

取得する最大メッセージ数。デフォルトは 50、最大 1000。

oldest

取得範囲の開始日時(YYYY-MM-DD HH:MM:SS 形式)。この日時以降のメッセージを取得します。

latest

取得範囲の終了日時(YYYY-MM-DD HH:MM:SS 形式)。この日時までのメッセージを取得します。

timezone

日時の解釈に使用するタイムゾーン。指定がない場合はデフォルト設定が使用されます。

ツール名:Get Users Cached

  • ツール概要

    • Slack ワークスペース内のユーザー情報を取得・検索する機能です。SQLite キャッシュを活用することで、高速かつ効率的にユーザーを探すことができます。

  • 入出力(引数と戻り値)

    • 引数(入力):

      • search:ユーザー名・メールアドレス・役職に対する検索語(大文字小文字は区別しない)。

      • from_:ページネーションの開始位置(0 ベース)。デフォルトは 0。

      • limit:取得する最大ユーザー数。デフォルト 50、最大 200。

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • 一致したユーザー

        • メタデータ

  • 使用例

    • await get_users_cached(search="sato")

    • await get_users_cached(search="john@company.com")

    • await get_users_cached(from_=0, limit=50) # 最初の50名を取得

設定項目
説明

search

ユーザー名・メールアドレス・役職に対する検索語(大文字小文字は区別しない)。

from_

ページネーションの開始位置(0 ベース)。デフォルトは 0。

limit

取得する最大ユーザー数。デフォルト 50、最大 200。

ツール名:Search Messages

  • ツール概要

    • ワークスペース内のすべてのチャンネルに対してメッセージ検索を行います。 ※ この機能を利用するには、user スコープの OAuth トークン(search:read 権限付き)が必要です。

  • 入出力(引数と戻り値)

    • 引数(入力):

      • query:検索したいキーワードやフレーズを含む検索クエリ文字列。

      • count:取得する検索結果の件数。デフォルトは 20、最大 100。

    • 戻り値(出力):

      • 以下の要素を含む辞書

        • 一致したユーザー

        • メタデータ

  • 使用例

    • await search_messages("project update", 10) { "messages": [ { "text": "Here's the project update...", "user": "U1234567890", "channel": "C1234567890", "ts": "1234567890.123456" } ], "query": "project update", "total": 1 }

設定項目
説明

query

検索したいキーワードやフレーズを含む検索クエリ文字列。

count

取得する検索結果の件数。デフォルトは 20、最大 100。

fincode byGMO

概要

fincode byGMO の決済APIにアクセスするためのMCP Server(Model Context Protocol server)です。顧客・カード・決済手段・決済・サブスクリプション・インボイスなどの各種操作を行えます。

設定項目
説明

API_KEY

fincode の APIキー。

API_AUTH_TYPE

API認証の種別。

EXTRA_HEADERS

リクエストに追加するヘッダー(任意)。

SERVER_URL_OVERRIDE

接続先サーバーURLの上書き(任意)。

ツール名:Post V1 Customers(顧客 登録)

  • ツール概要

    • 顧客情報を登録します。(HTTP Method: POST / Endpoint: /v1/customers)

  • 備考

    • id は任意の値を指定できます。指定しない場合はfincodeが自動生成します。一度登録された顧客IDは削除後も再利用できません。

設定項目
説明

id

顧客ID(任意。未指定で自動生成)。

name

顧客名(任意)。

email

メールアドレス(任意)。

phone_cc

電話番号の国コード(任意)。

phone_no

電話番号(任意)。

addr_country

住所:国コード(任意)。

addr_state

住所:都道府県(任意)。

addr_city

住所:市区町村(任意)。

addr_line_1

住所:町名・番地(任意)。

addr_line_2

住所:建物名・部屋番号(任意)。

addr_line_3

住所:その他(任意)。

addr_post_code

住所:郵便番号(任意)。

ツール名:Get V1 Customers(顧客 一覧取得)

  • ツール概要

    • 顧客情報を一覧で取得します。クエリパラメータで絞り込めます。(HTTP Method: GET / Endpoint: /v1/customers)

設定項目
説明

page

ページ番号(任意)。

limit

1回で取得する最大件数(任意、10〜100)。

count_only

総件数のみ取得するか(任意。true で total_count のみ取得)。

id

顧客ID(任意)。

name

顧客名(任意)。

email

メールアドレス(任意)。

created_from

作成日の範囲指定(開始日、yyyy/MM/dd、任意)。

created_to

作成日の範囲指定(終了日、yyyy/MM/dd、任意)。

ツール名:Get V1 Customers By Id(顧客 取得)

  • ツール概要

    • IDで指定した顧客情報を取得します。(HTTP Method: GET / Endpoint: /v1/customers/{id})

設定項目
説明

id

顧客ID(必須、パスパラメータ)。

ツール名:Put V1 Customers By Id(顧客 更新)

  • ツール概要

    • IDで指定した顧客情報を更新します。(HTTP Method: PUT / Endpoint: /v1/customers/{id})

設定項目
説明

id

顧客ID(必須、パスパラメータ)。

name

顧客名(任意)。

email

メールアドレス(任意)。

phone_cc

電話番号の国コード(任意)。

phone_no

電話番号(任意)。

addr_country

住所:国コード(任意)。

addr_state

住所:都道府県(任意)。

addr_city

住所:市区町村(任意)。

addr_line_1

住所:町名・番地(任意)。

addr_line_2

住所:建物名・部屋番号(任意)。

addr_line_3

住所:その他(任意)。

addr_post_code

住所:郵便番号(任意)。

ツール名:Delete V1 Customers By Id(顧客 削除)

  • ツール概要

    • IDで指定した顧客情報を削除します。(HTTP Method: DELETE / Endpoint: /v1/customers/{id})

設定項目
説明

id

顧客ID(必須、パスパラメータ)。

ツール名:Post V1 Customers By Customer Id Cards(カード 登録)

  • ツール概要

    • customer_id で指定した顧客にカードを登録します。(HTTP Method: POST / Endpoint: /v1/customers/{customer_id}/cards)

設定項目
説明

customer_id

カードが紐づく顧客のID(必須、パスパラメータ)。

token

カードトークン(必須)。

default_flag

デフォルトフラグ(必須)。

ツール名:Get V1 Customers By Customer Id Cards(カード 一覧取得)

  • ツール概要

    • customer_id で指定した顧客に紐づくカードを一覧で取得します。(HTTP Method: GET / Endpoint: /v1/customers/{customer_id}/cards)

設定項目
説明

customer_id

顧客ID(必須、パスパラメータ)。

ツール名:Get V1 Customers By Customer Id Cards By Id(カード 取得)

  • ツール概要

    • customer_id で指定した顧客に紐づくカードのうち id で指定したものを取得します。(HTTP Method: GET / Endpoint: /v1/customers/{customer_id}/cards/{id})

設定項目
説明

customer_id

カードが紐づく顧客のID(必須、パスパラメータ)。

id

取得するカードのID(必須、パスパラメータ)。

ツール名:Put V1 Customers By Customer Id Cards By Id(カード 更新)

  • ツール概要

    • customer_id で指定した顧客に紐づくカードのうち id で指定したものを更新します。(HTTP Method: PUT / Endpoint: /v1/customers/{customer_id}/cards/{id})

設定項目
説明

customer_id

カードが紐づく顧客のID(必須、パスパラメータ)。

id

更新するカードのID(必須、パスパラメータ)。

token

カードトークン(任意)。

default_flag

デフォルトフラグ。指定した場合のみ更新(任意)。

holder_name

カード名義人名(任意。token入力時は無視)。

expire

カード有効期限(YYMM形式、任意。token入力時は無視)。

ツール名:Delete V1 Customers By Customer Id Cards By Id(カード 削除)

  • ツール概要

    • customer_id で指定した顧客に紐づくカードのうち id で指定したものを削除します。(HTTP Method: DELETE / Endpoint: /v1/customers/{customer_id}/cards/{id})

設定項目
説明

customer_id

カードが紐づく顧客のID(必須、パスパラメータ)。

id

削除するカードのID(必須、パスパラメータ)。

ツール名:Post V1 Customers By Customer Id Payment Methods(決済手段 登録)

  • ツール概要

    • customer_id で指定した顧客に決済手段を登録します。(HTTP Method: POST / Endpoint: /v1/customers/{customer_id}/payment_methods)

  • 備考

    • pay_type が "Card" の場合は card オブジェクト、"Directdebit"(口座振替)の場合は directdebit オブジェクトが必須です。

設定項目
説明

customer_id

顧客ID(必須、パスパラメータ)。

pay_type

決済種別(必須)。

default_flag

デフォルトフラグ(必須)。

return_url

完了時のリターンURL(任意)。

return_url_on_failure

失敗時のリターンURL(任意)。

client_field_1〜3

加盟店自由項目 1〜3(任意)。

card

カード情報オブジェクト(pay_type="Card" のとき必須)。

card.token

カードトークン(card指定時は必須)。

card.tds_type / card.tds2_type

3Dセキュア利用種別・非対応時設定(任意)。

card.tds2_*(3Dセキュア2.0認証パラメータ群)

3Dセキュア2.0認証に使用する各種パラメータ群(請求先/配送先住所、電話番号、アカウント情報、注文・配送情報など)。すべて任意。※詳細は fincode API リファレンス参照。

directdebit

口座情報オブジェクト(pay_type="Directdebit" のとき必須)。

directdebit.application_type

申込種別(必須)。

directdebit.bank_code

銀行コード(必須)。

directdebit.branch_code

支店コード(ゆうちょ以外で必須)。

directdebit.account_type

預金区分(1:普通/2:当座。ゆうちょ以外で必須)。

directdebit.account_number

口座番号(左0埋め。ゆうちょ以外で必須)。

directdebit.account_name

口座名義(任意)。

directdebit.account_name_kana

口座名義(カナ)(必須)。

directdebit.paper_application

書面申込フラグ(任意)。

ツール名:Get V1 Customers By Customer Id Payment Methods(決済手段 一覧取得)

  • ツール概要

    • customer_id で指定した顧客に紐づく決済手段を一覧で取得します。(HTTP Method: GET / Endpoint: /v1/customers/{customer_id}/payment_methods)

設定項目
説明

customer_id

顧客ID(必須、パスパラメータ)。

pay_type

決済種別(任意)。現時点では Directdebit(口座振替)のみ指定可能。カードは カード一覧取得APIを使用。

ツール名:Get V1 Customers By Customer Id Payment Methods By Id(決済手段 取得)

  • ツール概要

    • customer_id で指定した顧客に紐づく決済手段のうち id で指定したものを取得します。(HTTP Method: GET / Endpoint: /v1/customers/{customer_id}/payment_methods/{id})

設定項目
説明

customer_id

顧客ID(必須、パスパラメータ)。

id

決済手段ID(必須、パスパラメータ)。

pay_type

決済種別(任意)。現時点では Directdebit のみ指定可能。

ツール名:Delete V1 Customers By Customer Id Payment Methods By Id(決済手段 削除)

  • ツール概要

    • customer_id で指定した顧客に紐づく決済手段のうち id で指定したものを削除します。(HTTP Method: DELETE / Endpoint: /v1/customers/{customer_id}/payment_methods/{id})

設定項目
説明

customer_id

顧客ID(必須、パスパラメータ)。

id

決済手段ID(必須、パスパラメータ)。

ツール名:Get V1 Payments(決済 一覧取得)

  • ツール概要

    • 決済情報の一覧を取得します。(HTTP Method: GET / Endpoint: /v1/payments)

設定項目
説明

クエリ

決済の一覧取得における検索条件となるクエリパラメータ(必須)。

ツール名:Post V1 Payments(決済 登録)

  • ツール概要

    • 決済情報をfincodeに登録します。登録に成功した時点ではまだ顧客に請求はされていません。(HTTP Method: POST / Endpoint: /v1/payments)

ツール名:Put V1 Payments By Id(決済 実行)

  • ツール概要

    • fincodeに登録された決済情報を指定し、請求を実行します。(HTTP Method: PUT / Endpoint: /v1/payments/{id})

設定項目
説明

id

オーダーID(決済情報のID)(必須、パスパラメータ)。

ツール名:Get V1 Payments By Id(決済 取得)

  • ツール概要

    • 指定した決済情報を取得します。(HTTP Method: GET / Endpoint: /v1/payments/{id})

設定項目
説明

id

オーダーID(決済情報のID)(必須、パスパラメータ)。

pay_type

決済種別(任意、クエリパラメータ)。

ツール名:Put V1 Payments By Id Capture(決済 売上確定)

  • ツール概要

    • status が仮売上(AUTHORIZED)またはキャンセル(CANCELED)の決済に対して売上確定を行います。成功すると status は CAPTURED に遷移します。(HTTP Method: PUT / Endpoint: /v1/payments/{id}/capture)

設定項目
説明

id

オーダーID(決済情報のID)(必須、パスパラメータ)。

ツール名:Put V1 Payments By Id Cancel(決済 キャンセル)

  • ツール概要

    • 決済をキャンセルします。成功すると status はキャンセル済み(CANCELED)に遷移します。返金方法は決済手段により異なります。(HTTP Method: PUT / Endpoint: /v1/payments/{id}/cancel)

設定項目
説明

id

オーダーID(決済情報のID)(必須、パスパラメータ)。

ツール名:Put V1 Payments By Id Auth(決済 再オーソリ)

  • ツール概要

    • 決済のオーソリを再度実行します。pay_type が Card かつ status が CANCELED の決済に対して実行でき、初回決済時の情報を引き継ぎます。(HTTP Method: PUT / Endpoint: /v1/payments/{id}/auth)

設定項目
説明

id

オーダーID(決済情報のID)(必須、パスパラメータ)。

ツール名:Put V1 Payments By Id Change(決済 金額変更)

  • ツール概要

    • 決済の利用金額を変更します。売上確定済みは請求金額、仮売上は与信枠の金額が変更されます。(HTTP Method: PUT / Endpoint: /v1/payments/{id}/change)

設定項目
説明

id

オーダーID(決済情報のID)(必須、パスパラメータ)。

ツール名:Put V1 Payments By Id Secure(認証後決済 実行)

  • ツール概要

    • 3Dセキュア認証後の決済を実行します。認証結果(tds2_trans_result)が Y または A のときに呼び出します。(HTTP Method: PUT / Endpoint: /v1/payments/{id}/secure)

設定項目
説明

id

オーダーID(決済情報のID)(必須、パスパラメータ)。

pay_type

決済種別(必須。例:Googlepay)。

access_id

取引ID(必須)。

pa_res

3Dセキュアサービス結果電文(3Dセキュア1.0利用時のみ必須、任意)。

ツール名:Put V1 Payments By Id Barcode(バーコード発行)

  • ツール概要

    • リクエストしたデバイス情報に合わせてコンビニ決済のバーコードを再発行します。(HTTP Method: PUT / Endpoint: /v1/payments/{id}/barcode)

設定項目
説明

id

オーダーID(決済情報のID)(必須、パスパラメータ)。

pay_type

決済種別(必須。例:Konbini)。

access_id

取引ID(必須)。

device_name

デバイス名(必須)。

win_width

ウィンドウ幅(必須)。

win_height

ウィンドウ高さ(必須)。

pixel_ratio

ピクセル比(必須)。

win_size_type

ウィンドウサイズ種別(必須)。


ツール名:Put V1 Secure2 By Access Id(3Dセキュア 認証実行)

  • ツール概要

    • access_id で指定したカード決済取引の3Dセキュア2.0認証を開始します。tds2_ret_url に ThreeDSecureMethodFinished/ThreeDSecureMethodSkipped イベントが通知されたときに呼び出します。(HTTP Method: PUT / Endpoint: /v1/secure2/{access_id})

  • 備考

    • レスポンスの tds2_trans_result が Y/A のときは認証後決済 実行APIを、C のときは challenge_url でチャレンジ認証後に結果確定APIを呼び出します。

設定項目
説明

access_id

取引ID(必須、パスパラメータ)。

pay_type

決済種別(任意。未指定で Card。Card/Googlepay)。

param

認証パラメータ(必須)。

ツール名:Get V1 Secure2 By Access Id(3Dセキュア 認証結果確定)

  • ツール概要

    • access_id で指定したカード決済取引の3Dセキュア認証結果を確定します。チャレンジ認証後に AuthResultReady イベントが通知されたときに呼び出します。(HTTP Method: GET / Endpoint: /v1/secure2/{access_id})

設定項目
説明

access_id

取引ID(必須、パスパラメータ)。

pay_type

決済種別(任意。未指定で Card。Card/Googlepay)。

ツール名:Post V1 Sessions(決済URL 作成)

  • ツール概要

    • fincodeが提供するリダイレクト型決済ページを発行し、そのURLを返します。(HTTP Method: POST / Endpoint: /v1/sessions)

設定項目
説明

transaction

決済共通項目オブジェクト(必須)。

transaction.amount

決済金額(必須)。

transaction.pay_type

決済種別(任意)。

transaction.order_id

オーダーID(決済後生成される決済情報のIDを予め指定、任意)。

transaction.tax

税送料(任意)。

transaction.client_field_1〜3

加盟店自由項目 1〜3(任意)。

card

カード決済パラメータオブジェクト(pay_type に Card を含む場合、任意)。

card.job_code

処理区分(AUTH:仮売上/CAPTURE:即時売上)(card指定時は必須)。

card.tds_type / card.tds2_type

3Dセキュア利用種別・非対応時設定(任意)。

card.tds2_*(3Dセキュア2.0認証パラメータ群)

3Dセキュア2.0認証に使用する各種パラメータ群(請求先/配送先住所、電話番号、アカウント情報、注文・配送情報など)。すべて任意。

konbini

コンビニ決済パラメータオブジェクト(任意)。

konbini.payment_term_day

支払期限日数(任意)。

konbini.konbini_reception_mail_send_flag

コンビニ受付メール送信フラグ(必須)。

paypay

PayPayパラメータオブジェクト(任意)。

paypay.job_code

処理区分(AUTH:仮売上/CAPTURE:即時売上)(必須)。

paypay.order_description

注文説明(任意)。

virtualaccount

銀行振込パラメータオブジェクト(任意)。

virtualaccount.payment_term_day

支払期限日数(任意)。

virtualaccount.virtualaccount_reception_mail_send_flag

受付メール送信フラグ(必須)。

virtualaccount.reference_order_id

参照オーダーID(任意)。

success_url / cancel_url

成功/キャンセル時のリダイレクトURL(任意)。

expire

決済URLの有効期限(yyyy/MM/dd HH:mm:ss。デフォルト24時間/最長30日/最短5分、任意)。

shop_service_name

ショップ・サービス名(任意)。

guide_mail_send_flag

決済メール送信フラグ(0:送信しない/1:送信する、任意)。

receiver_mail

送信先メールアドレス(任意)。

mail_customer_name

メール宛名(任意)。

thanks_mail_send_flag

サンクスメール送信フラグ(任意)。

shop_mail_template_id

ショップメールテンプレートID(任意)。

ツール名:Post V1 Card Sessions(カード登録URL 作成)

  • ツール概要

    • fincodeが提供するリダイレクト型カード登録ページを発行し、そのURLを返します。(HTTP Method: POST / Endpoint: /v1/card_sessions)

設定項目
説明

success_url / cancel_url

成功/キャンセル時のリダイレクトURL(任意)。

expire

カード登録URLの有効期限(yyyy/MM/dd HH:mm:ss、任意)。

shop_service_name

ショップ・サービス名(任意)。

receiver_mail

送信先メールアドレス(任意)。

mail_customer_name

メール宛名(任意)。

guide_mail_send_flag

案内メール送信フラグ(任意)。

completion_mail_send_flag

完了メール送信フラグ(任意)。

shop_mail_template_id

ショップメールテンプレートID(任意)。

customer_id

顧客ID(任意)。

customer_name

顧客名(任意)。

td_tenant_name

3Dセキュア表示店舗名(任意)。

tds_type / tds2_type

3Dセキュア利用種別・非対応時設定(任意)。

tds2_*(3Dセキュア2.0認証パラメータ群)

3Dセキュア2.0認証に使用する各種パラメータ群(請求先/配送先住所、電話番号、アカウント情報、注文・配送情報など)。すべて任意。

ツール名:Post V1 Plans(プラン 登録)

  • ツール概要

    • プラン情報を登録します。(HTTP Method: POST / Endpoint: /v1/plans)

設定項目
説明

id

プランID(任意)。

plan_name

プラン名(必須)。

description

説明(任意)。

amount

金額(必須)。

tax

税送料(任意)。

interval_pattern

課金間隔(month/year、任意)。

interval_count

課金間隔の回数(任意)。

ツール名:Get V1 Plans(プラン 一覧取得)

  • ツール概要

    • プラン情報を一覧で取得します。クエリパラメータで絞り込めます。(HTTP Method: GET / Endpoint: /v1/plans)

設定項目
説明

page

ページ番号(任意)。

limit

1回で取得する最大件数(任意、10〜100)。

count_only

総件数のみ取得するか(任意)。

total_amount_min

合計金額(始値)(任意)。

total_amount_max

合計金額(終値)(任意)。

interval_pattern

課金間隔(month/year、任意)。

update_date_from

更新日時(始値、yyyy/MM/dd、任意)。

update_date_to

更新日時(終値、yyyy/MM/dd、任意)。

plan_name

プラン名(部分一致、任意)。

delete_flag

削除済みフラグ(0/1、任意)。

ツール名:Get V1 Plans By Id(プラン 取得)

  • ツール概要

    • IDで指定したプラン情報を取得します。(HTTP Method: GET / Endpoint: /v1/plans/{id})

設定項目
説明

id

プランID(必須、パスパラメータ)。

ツール名:Put V1 Plans By Id(プラン 更新)

  • ツール概要

    • IDで指定したプラン情報を更新します。1つ以上のサブスクリプションで使用中(used_flag=1)のプランは更新できません。(HTTP Method: PUT / Endpoint: /v1/plans/{id})

設定項目
説明

id

プランID(必須、パスパラメータ)。

plan_name

プラン名(任意)。

description

説明(任意)。

amount

金額(任意)。

tax

税送料(任意)。

interval_pattern

課金間隔(任意)。

interval_count

課金間隔の回数(任意)。

ツール名:Delete V1 Plans By Id(プラン 削除)

  • ツール概要

    • IDで指定したプラン情報を削除します。1つ以上のサブスクリプションで使用中(used_flag=1)のプランは削除できません。(HTTP Method: DELETE / Endpoint: /v1/plans/{id})

設定項目
説明

id

プランID(必須、パスパラメータ)。

ツール名:Post V1 Subscriptions(サブスクリプション 登録)

  • ツール概要

    • customer_id で指定した顧客に plan_id で指定したプランを適用したサブスクリプションを登録します。(HTTP Method: POST / Endpoint: /v1/subscriptions)

設定項目
説明

id

サブスクリプションID(任意)。

pay_type

決済種別(必須)。

plan_id

プランID(必須)。

customer_id

顧客ID(必須)。

card_id

カードID(pay_type=Card のみ。省略時は顧客のデフォルトカード、任意)。

payment_method_id

決済手段ID(pay_type=Directdebit のみ。省略時はデフォルト決済手段、任意)。

start_date

課金開始日(yyyy/MM/dd、必須)。

stop_date

課金停止日(省略時は無期限、任意)。

end_month_flag

月末フラグ(任意)。

initial_amount

初回金額(任意)。

initial_tax

初回税送料(任意)。

remarks

ご利用明細表示内容(pay_type=Directdebit のみ、任意)。

client_field_1〜3

加盟店自由項目 1〜3(任意)。

send_url

送信URL(任意)。

ツール名:Get V1 Subscriptions(サブスクリプション 一覧取得)

  • ツール概要

    • サブスクリプション情報を一覧で取得します。クエリパラメータで絞り込めます。(HTTP Method: GET / Endpoint: /v1/subscriptions)

設定項目
説明

page / limit / count_only

ページ番号/最大件数(10〜100)/総件数のみ取得(いずれも任意)。

pay_type

決済種別(Card/Directdebit、任意)。

id / customer_id / plan_id

サブスクID/顧客ID/プランID(任意)。

status

ステータス(ACTIVE/RUNNING/CANCELED/INCOMPLETE。カンマ区切りでOR検索、任意)。

total_amount_min / total_amount_max

合計金額の範囲(任意)。

interval_pattern

課金間隔(任意)。

start_date_from / start_date_to

課金開始日の範囲(yyyy/MM/dd、任意)。

stop_date_from / stop_date_to

課金停止日の範囲(yyyy/MM/dd、任意)。

next_charge_date_from / next_charge_date_to

次回課金日の範囲(yyyy/MM/dd、任意)。

update_date_from / update_date_to

更新日時の範囲(yyyy/MM/dd、任意)。

ツール名:Get V1 Subscriptions By Id(サブスクリプション 取得)

  • ツール概要

    • IDで指定したサブスクリプション情報を取得します。(HTTP Method: GET / Endpoint: /v1/subscriptions/{id})

設定項目
説明

id

サブスクリプションID(必須、パスパラメータ)。

ツール名:Put V1 Subscriptions By Id(サブスクリプション 更新)

  • ツール概要

    • IDで指定したサブスクリプション情報を更新します(指定したパラメータのみ更新)。初回課金が済んでいる場合は更新できません。(HTTP Method: PUT / Endpoint: /v1/subscriptions/{id})

設定項目
説明

id

サブスクリプションID(必須、パスパラメータ)。

pay_type

決済種別(必須)。

plan_id

プランID(任意)。

start_date / stop_date

課金開始日/停止日(任意)。

end_month_flag

月末フラグ(任意)。

initial_amount / initial_tax

初回金額/初回税送料(任意)。

remarks

ご利用明細表示内容(任意)。

client_field_1〜3

加盟店自由項目 1〜3(任意)。

ツール名:Delete V1 Subscriptions By Id(サブスクリプション 解約)

  • ツール概要

    • IDで指定したサブスクリプションを解約し、請求を停止します。(HTTP Method: DELETE / Endpoint: /v1/subscriptions/{id})

設定項目
説明

id

サブスクリプションID(必須、パスパラメータ)。

ツール名:Get V1 Subscriptions By Id Result(サブスクリプション結果 一覧取得)

  • ツール概要

    • サブスクリプションにより発生した課金結果を一覧で取得します。(HTTP Method: GET / Endpoint: /v1/subscriptions/{id}/result)

設定項目
説明

id

サブスクリプションID(必須、パスパラメータ)。

page / limit / count_only

ページ番号/最大件数/総件数のみ取得(任意)。

pay_type

決済種別(任意)。

ツール名:Get V1 Payments Bulk(一括決済 一覧取得)

  • ツール概要

    • fincodeに登録した一括決済情報を一覧で取得します。(HTTP Method: GET / Endpoint: /v1/payments/bulk)

設定項目
説明

page / limit / count_only

ページ番号/最大件数/総件数のみ取得(任意)。

process_plan_date_from / process_plan_date_to

処理予定日の範囲(yyyy/MM/dd、任意)。

status

ステータス(CHECKING/CHECKED/RUNNING/COMPLETED/ERROR。カンマ区切りでOR検索、任意)。

pay_type

決済種別(任意)。

file_name

一括決済データファイル名(部分一致、任意)。

delete_flag

削除済みフラグ(任意)。

created_from / created_to

作成日時の範囲(yyyy/MM/dd、任意)。

ツール名:Post V1 Payments Bulk(一括決済 登録)

  • ツール概要

    • JSON形式のファイルで一括決済情報を登録し、process_plan_date で指定した日時に一括決済処理を予約します。(HTTP Method: POST / Endpoint: /v1/payments/bulk)

設定項目
説明

file

一括決済情報のファイル(任意)。

ツール名:Get V1 Payments Bulk By Id(一括決済詳細 一覧取得)

  • ツール概要

    • IDで指定した一括決済情報の詳細(決済1件ごとの情報)と各決済のエラー情報を一覧で取得します。(HTTP Method: GET / Endpoint: /v1/payments/bulk/{id})

設定項目
説明

id

一括決済ID(必須、パスパラメータ)。

page / limit / count_only

ページ番号/最大件数/総件数のみ取得(任意)。

pay_type

決済種別(Card など、任意)。

order_id

オーダーID(任意)。

status

ステータス(CHECKED/SUCCEEDED/FAILED。カンマ区切りでOR検索、任意)。

ツール名:Delete V1 Payments Bulk By Id(一括決済 削除)

  • ツール概要

    • IDで指定した一括決済情報を削除します。チェック済み(status=CHECKED)のものに限り削除できます。(HTTP Method: DELETE / Endpoint: /v1/payments/bulk/{id})

設定項目
説明

id

一括決済ID(必須、パスパラメータ)。

ツール名:Get V1 Invoices(インボイス 一覧取得)

  • ツール概要

    • インボイス情報を一覧で取得します。クエリパラメータで絞り込めます。(HTTP Method: GET / Endpoint: /v1/invoices)

設定項目
説明

page / limit / count_only

ページ番号/最大件数/総件数のみ取得(任意)。

status

ステータス(DRAFT/AWAITING_CUSTOMER_PAYMENT/PAID/CANCELED。カンマ区切りで複数指定、任意)。

keyword

キーワード(client_field_1〜3 の部分一致、任意)。

due_date_from / due_date_to

支払期日の範囲(yyyy/MM/dd、任意)。

issue_date_from / issue_date_to

発行日の範囲(yyyy/MM/dd、任意)。

total_amount_min / total_amount_max

合計金額の範囲(任意)。

created_from / created_to

作成日の範囲(yyyy/MM/dd、任意)。

customer_id / customer_name

顧客ID(完全一致)/顧客名(部分一致)(任意)。

invoice_number

請求番号(一致検索、任意)。

lines_date_from / lines_date_to

取引日付の範囲(yyyy/MM/dd、任意)。

transaction_date_from / transaction_date_to

支払完了日の範囲(yyyy/MM/dd、任意)。

is_uncollectible

回収困難マーク(true/false/null、任意)。

ツール名:Post V1 Invoices(インボイス 作成)

  • ツール概要

    • インボイス情報を作成します。取引内容や決済手段などは後からインボイス更新APIで入力することも可能です。発行APIを呼び出すまで請求は行われません。(HTTP Method: POST / Endpoint: /v1/invoices)

設定項目
説明

id

インボイスID(ショップ内で一意。未指定で自動生成、任意)。

bill_mail_send_flag

請求書メール送信フラグ(0/1、任意)。

receipt_mail_send_flag

領収書メール送信フラグ(0/1、任意)。

underpayment_mail_send_flag

差額請求メール送信フラグ(0/1、任意)。

invoice_number

請求番号(未指定で自動採番、任意)。

customer_id

顧客(請求先)ID(任意)。

customer_honorific

顧客(請求先)敬称(任意)。

customer_overwrite

上書き顧客(請求先)情報オブジェクト(name/email/住所一式。任意)。

issuer_overwrite

発行元事業者情報オブジェクト(住所/email/電話番号一式。任意)。

lines

取引内容(配列、任意)。

pay_types

利用可能な決済種別のリスト(Virtualaccount/Card など、任意)。

card

カード決済情報オブジェクト(任意)。

card.job_code

処理区分(AUTH:仮売上/CAPTURE:即時売上、任意)。

card.tds_type / card.tds2_type

3Dセキュア利用種別・非対応時設定(任意)。

card.tds2_*(3Dセキュア2.0認証パラメータ群)

3Dセキュア2.0認証に使用する各種パラメータ群(請求先/配送先住所、電話番号、アカウント情報、注文・配送情報など)。すべて任意。

virtual_account

バーチャル口座情報オブジェクト(任意)。

virtual_account.reference_invoice_id

バーチャル口座 再利用 インボイスID(任意。再利用条件あり)。

client_field_1〜3

加盟店自由項目 1〜3(任意)。

ツール名:Get V1 Invoices By Id(インボイス 取得)

指定したIDを持つインボイス情報を取得します。(HTTP Method: GET / Endpoint: /v1/invoices/{id})

設定項目
説明

id

インボイスID(必須、パスパラメータ)。

ツール名:Put V1 Invoices By Id(インボイス 更新)

指定したIDを持つインボイス情報を更新します。インボイス 発行APIを呼び出すまで請求は行われません。発行後は 回収困難フラグ、および 加盟店自由項目 のみが更新可能です。(HTTP Method: PUT / Endpoint: /v1/invoices/{id})

設定項目
説明

id

インボイスID(必須、パスパラメータ)。

is_uncollectible

回収困難フラグ(任意)。

bill_mail_send_flag

請求書メール送信フラグ(0:送信しない/1:送信する、任意)。

receipt_mail_send_flag

領収書メール送信フラグ(0/1、任意)。

underpayment_mail_send_flag

差額請求メール送信フラグ(0/1、任意)。

invoice_number

請求番号(未指定で自動採番、任意)。

customer_id

顧客(請求先)ID(任意)。

customer_honorific

顧客(請求先)敬称(任意)。

customer_overwrite

上書き顧客(請求先)情報オブジェクト(name/email/住所一式。任意)。

issuer_overwrite

発行元事業者情報オブジェクト(住所/email/電話番号一式。任意)。

issue_date

発行年月日(yyyy/MM/dd、任意)。

lines

取引内容(配列、任意)。

pay_types

利用可能な決済種別のリスト(Virtualaccount/Card など、任意)。

card

カード決済情報オブジェクト(任意)。

card.job_code

処理区分(AUTH:仮売上/CAPTURE:即時売上、任意)。

card.tds_type / card.tds2_type

3Dセキュア利用種別・非対応時設定(任意)。

card.tds2_*(3Dセキュア2.0認証パラメータ群)

3Dセキュア2.0認証に使用する各種パラメータ群(請求先/配送先住所、電話番号、アカウント情報、注文・配送情報など)。すべて任意。

virtual_account

バーチャル口座情報オブジェクト(reference_invoice_id 等、任意)。

client_field_1〜3

加盟店自由項目 1〜3(任意)。

ツール名:Delete V1 Invoices By Id(インボイス 削除)

指定したIDを持つ下書き状態のインボイス情報を削除します。発行済みのインボイス情報は削除できません。(HTTP Method: DELETE / Endpoint: /v1/invoices/{id})

設定項目
説明

id

インボイスID(必須、パスパラメータ)。

ツール名:Put V1 Invoices By Id Open(インボイス 発行)

IDで指定したインボイス情報をもとに請求を開始します。請求書WebページのURL発行、請求先顧客へのメール送信などを行います。発行後は更新APIで 回収困難フラグ と 加盟店自由項目 のみ更新できます。(HTTP Method: PUT / Endpoint: /v1/invoices/{id}/open)

設定項目
説明

id

インボイスID(必須、パスパラメータ)。

bill_mail_send_flag

請求書メール送信フラグ(0/1。登録・更新より優先、任意)。

receipt_mail_send_flag

領収書メール送信フラグ(0/1。登録・更新より優先、任意)。

underpayment_mail_send_flag

差額請求メール送信フラグ(0/1。登録・更新より優先、任意)。

ツール名:Put V1 Invoices By Id Cancel(インボイス キャンセル)

指定したIDを持つ発行済みのインボイス情報をキャンセルします。一度キャンセルしたインボイス情報をもとに再度請求することはできません。(HTTP Method: PUT / Endpoint: /v1/invoices/{id}/cancel)

設定項目
説明

id

インボイスID(必須、パスパラメータ)。

ツール名:Put V1 Invoices By Id Paid Externally(インボイス 外部支払いマーク)

発行済みのインボイスを、fincode以外の方法で支払われたものとしてマークします。ステータスが PAID に遷移し、is_paid_externally が true になります。(HTTP Method: PUT / Endpoint: /v1/invoices/{id}/paid_externally)

設定項目
説明

id

インボイスID(必須、パスパラメータ)。

transaction_date

支払い完了日(yyyy/MM/dd、任意)。

ツール名:Put V1 Invoices By Id Virtual Account Refresh(インボイス バーチャル口座再発行)

指定したインボイスに割り当てられたバーチャル口座が期限切れでクローズされている場合、新たなバーチャル口座を割り当てます。(HTTP Method: PUT / Endpoint: /v1/invoices/{id}/virtual_account/refresh)

設定項目
説明

id

インボイスID(必須、パスパラメータ)。

ツール名:Get V1 Accounts(売上入金 一覧取得)

売上入金情報を一覧で取得します。クエリパラメータで絞り込めます。(HTTP Method: GET / Endpoint: /v1/accounts)

設定項目
説明

page

ページ番号(任意)。

limit

1回で取得する最大件数(任意、10〜100)。

count_only

総件数のみ取得するか(任意。true で total_count のみ取得)。

processed

確定日(入金サイクルの締め日)を月単位で絞り込み(yyyy/MM、任意)。

status

入金ステータス(3001〜3013。カンマ区切りでOR検索、任意)。

scheduled_from

入金予定日の範囲指定(開始日、yyyy/MM/dd、任意)。

scheduled_to

入金予定日の範囲指定(終了日、yyyy/MM/dd、任意)。

ツール名:Get V1 Accounts By Id(売上入金 取得)

IDで指定した売上入金を取得します。集計期間(aggregate_term_start〜end)の売上集計結果を含みます。(HTTP Method: GET / Endpoint: /v1/accounts/{id})

設定項目
説明

id

売上入金ID(必須、パスパラメータ)。

ツール名:Get V1 Accounts By Id Detail(売上入金詳細 一覧取得)

IDで指定した売上入金に紐づく詳細を一覧で取得します。各明細は決済/キャンセル/チャージバック/チャージバック取消調整のいずれかに対応します。(HTTP Method: GET / Endpoint: /v1/accounts/{id}/detail)

設定項目
説明

id

売上入金ID(必須、パスパラメータ)。

page

ページ番号(任意)。

limit

1回で取得する最大件数(任意、10〜100)。

count_only

総件数のみ取得するか(任意)。

ツール名:Get V1 Platform Accounts(プラットフォーム利用料収入 一覧取得)

プラットフォーム利用料による売上入金情報を一覧で取得します。クエリパラメータで絞り込めます。(HTTP Method: GET / Endpoint: /v1/platform_accounts)

設定項目
説明

page

ページ番号(任意)。

limit

1回で取得する最大件数(任意、10〜100)。

count_only

総件数のみ取得するか(任意)。

processed

確定日を月単位で絞り込み(yyyy/MM、任意)。

status

入金ステータス(3001〜3013、任意)。

scheduled_from

入金予定日の範囲指定(開始日、yyyy/MM/dd、任意)。

scheduled_to

入金予定日の範囲指定(終了日、yyyy/MM/dd、任意)。

ツール名:Get V1 Platform Accounts By Id(プラットフォーム利用料収入 取得)

IDで指定したプラットフォーム利用料による売上入金情報を取得します。テナント別の利用料収入はサマリー一覧取得APIで取得できます。(HTTP Method: GET / Endpoint: /v1/platform_accounts/{id})

設定項目
説明

id

プラットフォーム利用料収入ID(必須、パスパラメータ)。

ツール名:Get V1 Platform Accounts By Id Summary(プラットフォーム利用料収入サマリー 一覧取得)

IDで指定したプラットフォーム利用料収入のサマリー(テナント別の利用料収入情報を含む)を一覧で取得します。(HTTP Method: GET / Endpoint: /v1/platform_accounts/{id}/summary)

設定項目
説明

id

プラットフォーム利用料収入ID(必須、パスパラメータ)。

page

ページ番号(任意)。

limit

1回で取得する最大件数(任意、10〜100)。

count_only

総件数のみ取得するか(任意)。

scheduled_from

入金予定日の範囲指定(開始日、yyyy/MM/dd、任意)。

scheduled_to

入金予定日の範囲指定(終了日、yyyy/MM/dd、任意)。

ツール名:Get V1 Platforms(プラットフォームショップ 一覧取得)

プラットフォームショップ(メインショップ・サブショップ)を一覧で取得します。クエリパラメータで絞り込めます。(HTTP Method: GET / Endpoint: /v1/platforms)

設定項目
説明

page

ページ番号(任意)。

limit

1回で取得する最大件数(任意、10〜100)。

count_only

総件数のみ取得するか(任意)。

id

ショップID(任意)。

shop_name

ショップ名(任意)。

shop_mail_address

ショップメールアドレス(任意)。

created_from

作成日の範囲指定(開始日、yyyy/MM/dd、任意)。

created_to

作成日の範囲指定(終了日、yyyy/MM/dd、任意)。

ツール名:Get V1 Platforms By Id(プラットフォームショップ 取得)

id で指定したプラットフォームショップを取得します。(HTTP Method: GET / Endpoint: /v1/platforms/{id})

設定項目
説明

id

ショップID(必須、パスパラメータ)。

ツール名:Put V1 Platforms By Id(プラットフォームショップ 更新)

examination_master_id で指定した決済手段に関するプラットフォーム利用料を更新します。(HTTP Method: PUT / Endpoint: /v1/platforms/{id})

設定項目
説明

id

ショップID(必須、パスパラメータ)。

examination_master_id

対象の決済手段ID(必須)。

platform_rate

プラットフォーム利用料率(任意)。

fixed_fee

最低料金(任意)。

web_registration_fee

Web登録手数料(任意)。

ツール名:Get V1 Tenants(テナントショップ 一覧取得)

テナントショップを一覧で取得します。クエリパラメータで絞り込めます。(HTTP Method: GET / Endpoint: /v1/tenants)

設定項目
説明

page

ページ番号(任意)。

limit

1回で取得する最大件数(任意、10〜100)。

count_only

総件数のみ取得するか(任意)。

id

ショップID(任意)。

shop_name

ショップ名(任意)。

shop_mail_address

ショップメールアドレス(任意)。

created_from

作成日の範囲指定(開始日、yyyy/MM/dd、任意)。

created_to

作成日の範囲指定(終了日、yyyy/MM/dd、任意)。

ツール名:Get V1 Tenants By Id(テナントショップ 取得)

id で指定したテナント情報を取得します。(HTTP Method: GET / Endpoint: /v1/tenants/{id})

設定項目
説明

id

ショップID(必須、パスパラメータ)。

ツール名:Put V1 Tenants By Id(テナントショップ 更新)

examination_master_id で指定した決済手段におけるプラットフォーム利用料などの設定を、id で指定したテナントに対して更新します。(HTTP Method: PUT / Endpoint: /v1/tenants/{id})

設定項目
説明

id

ショップID(必須、パスパラメータ)。

examination_master_id

対象の決済手段ID(任意)。

platform_rate

(個別)プラットフォーム利用料率(任意)。

fixed_fee

(個別)最低料金(任意)。

web_registration_fee

(個別)Web登録手数料(任意)。

paypay_content_category_type

PayPay商材カテゴリー(1:物販/サービス、2:デジタルコンテンツ。PayPayのみ、任意)。

api_key_display_flag

APIキー表示フラグ(0:表示しない/1:表示する、任意)。

ツール名:Post V1 Tenant Entries(テナントショップ 作成(新規ユーザー登録))

新規ユーザーを作成し、そのユーザーをオーナーとして新規テナントショップを作成します。成功すると登録メールアドレス宛に認証メールが送信されます。(HTTP Method: POST / Endpoint: /v1/tenant_entries)

設定項目
説明

email

メールアドレス(必須)。

password

パスワード(必須)。

name

名前(必須)。

tenant_url_id

テナントURL ID(必須)。

ツール名:Post V1 Join Tenants(テナントショップ 作成(既存ユーザー参加))

指定したプラットフォームショップのユーザーをオーナーとして新規テナントショップを作成します。(HTTP Method: POST / Endpoint: /v1/join_tenants)

設定項目
説明

email

メールアドレス(必須)。

password

パスワード(必須)。

tenant_url_id

テナントURL ID(必須)。

ツール名:Get V1 Contracts Examinations V2 Tenants By Id(テナントショップ本番環境申請情報 取得)

id で指定したテナントショップの本番環境申請情報を取得します(Tenant-Shop-Id ヘッダーも併せて指定)。(HTTP Method: GET / Endpoint: /v1/contracts/examinations_v2/tenants/{id})

設定項目
説明

id

ショップID(必須、パスパラメータ)。

ツール名:Put V1 Contracts Examinations V2 Tenants By Id(テナントショップ本番環境申請情報 更新)

id で指定したテナントショップの本番環境申請情報を更新します(Tenant-Shop-Id ヘッダーも併せて指定)。(HTTP Method: PUT / Endpoint: /v1/contracts/examinations_v2/tenants/{id})

設定項目
説明

id

ショップID(必須、パスパラメータ)。

contract_info

契約情報(fincodeと契約する事業者の情報、任意)。

shop_info

ショップ情報(任意)。

bank_account_info

銀行口座情報(売上入金受取用、任意)。

deposit_cycle_info

入金サイクル情報(任意)。

merchant_category_code

業種コード(fincodeから指定要求がある場合のみ、任意)。

ツール名:Post V1 Contracts Examinations Tenants By Id Files(テナントショップ 審査ファイルアップロード)

id で指定したテナントショップの審査に必要なファイルをアップロードします(Tenant-Shop-Id ヘッダーも併せて指定)。(HTTP Method: POST / Endpoint: /v1/contracts/examinations/tenants/{id}/files)

設定項目
説明

id

ショップID(必須、パスパラメータ)。

type

ファイル種別(必須)。

data

ファイルデータ(必須)。

ツール名:Post V1 Contracts Examinations(テナントショップ 本番環境申請)

テナントショップの本番環境利用申請を行います。事前に申請情報を更新APIで用意しておく必要があります。(HTTP Method: POST / Endpoint: /v1/contracts/examinations)

設定項目
説明

shop_id

ショップID(必須)。

enable_immediate_use

即時利用の有効化(必須)。

force_credit_check_skip

信用情報チェックを強制スキップするか(true は審査管理画面からの強制OK時のみ、必須)。

use_gmo_sign

GMOサインの利用(必須)。

ツール名:Post V1 Contracts Examinations Tenants By Id Providers Reserve(テナントショップ 決済手段追加申請)

id で指定したテナントショップの決済手段追加申請を行います(Tenant-Shop-Id ヘッダーも併せて指定)。申請状況の画面反映には最大24時間程度のタイムラグがあります。(HTTP Method: POST / Endpoint: /v1/contracts/examinations/tenants/{id}/providers/reserve)

設定項目
説明

id

ショップID(必須、パスパラメータ)。

provider

追加申請する決済手段(必須)。

ツール名:Get V1 Contracts By Id(テナントショップ契約情報 取得)

id で指定したテナントショップの契約情報を取得します(Tenant-Shop-Id ヘッダーも併せて指定)。(HTTP Method: GET / Endpoint: /v1/contracts/{id})

設定項目
説明

id

ショップID(必須、パスパラメータ)。

ツール名:Get V1 Contracts Examinations Tenants By Id((旧)テナントショップ本番環境申請情報 取得)

※ 現在非推奨です。新しい「テナントショップ本番環境申請情報 取得API」をご利用ください。id で指定したテナントショップの本番環境申請情報を取得します。(HTTP Method: GET / Endpoint: /v1/contracts/examinations/tenants/{id})

設定項目
説明

id

ショップID(必須、パスパラメータ)。

ツール名:Put V1 Contracts Examinations Tenants By Id((旧)テナントショップ本番環境申請情報 更新)

※ 現在非推奨です。新しい「テナントショップ本番環境申請情報 更新API」をご利用ください。id で指定したテナントショップの本番環境申請情報を更新します。(HTTP Method: PUT / Endpoint: /v1/contracts/examinations/tenants/{id})

設定項目
説明

id

ショップID(必須、パスパラメータ)。

update_contract_detail

契約情報を更新するか(任意)。

update_shop

ショップ情報を更新するか(任意)。

update_bank_account

銀行口座情報を更新するか(任意)。

update_deposit_cycle

入金サイクルを更新するか(任意)。

deposit_cycle_master_id

入金サイクルマスターID(任意)。

contract_detail

契約情報の詳細(任意)。

shop_item_detail

ショップ取扱商材情報(配列、任意)。

contract_bank_account

銀行口座情報(任意)。

ツール名:Post V1 Webhook Settings(Webhook設定 登録)

Webhook設定を登録します。(HTTP Method: POST / Endpoint: /v1/webhook_settings)

設定項目
説明

id

Webhook設定ID(任意)。

url

通知先URL(任意)。

event

通知対象イベント(必須)。

signature

署名(任意)。

最終更新