Skip to main content

​
Mintlify

ShanoneのMintlify連携は、デプロイ、ドキュメントAIエージェント/アシスタント、コンテンツ検索、サイト分析にまたがる16個のツールをエージェントに提供します。

​
はじめに

1

Mintlify APIキーを取得する

MintlifyダッシュボードでAdmin API key(デプロイ、分析用)を発行し、ドキュメントAIアシスタントを使う場合はAssistant API keyも発行します。
2

Shanoneにキーを追加する

ShanoneダッシュボードのIntegrations > Mintlifyで、手元にあるキーを貼り付けます——多くのツールはAdminキーだけで動作します。
3

リクエストを再実行する

保存が完了すると、mintlify_*ツールに対するshanone_execute_tool呼び出しが成功するようになります。

​
利用可能なツール

ShanoneはMintlify向けに16個のツールを、以下のカテゴリに整理して提供しています。
mintlify_trigger_preview, mintlify_trigger_deploy, mintlify_get_deploy_status
mintlify_create_agent_job, mintlify_get_agent_job, mintlify_send_agent_message — MintlifyのドキュメントAIエージェントに対してバックグラウンドジョブを実行する(例: コンテンツのレビューや更新)
mintlify_search, mintlify_get_page, mintlify_chat
mintlify_get_page_views, mintlify_get_visitors, mintlify_get_searches, mintlify_get_feedback, mintlify_get_feedback_by_page, mintlify_get_conversations, mintlify_get_caller_stats

​
よくあるユースケース

ドキュメントデプロイの自動化

コンテンツ変更後にプレビューデプロイをトリガーし、本番に反映する

コンテンツギャップ分析

人気の検索キーワードやフィードバックを取得し、改善が必要なページを見つける

AI支援による編集

ドキュメントの一部をスタイルガイドラインに照らしてレビューするエージェントジョブを実行する

利用状況レポート

週次のドキュメントレポート用にページビューや訪問者の傾向を要約する

​
トラブルシューティング

mintlify_get_deploy_statusをポーリングしてください——デプロイは非同期で1分以上かかることがあり、ツール呼び出しが返ってきてもビルドが完了したことを意味しません。
ページパスがdocs.jsonに登録されているものと完全に一致しているか確認してください(先頭のスラッシュや末尾の.mdx拡張子の有無に注意)。
エージェントジョブ系のツール(mintlify_create_agent_jobなど)には特にAssistant API keyが必要です——Adminキーだけでは認証されません。