AIコーディングツール

あなたのAIアシスタントにmindzieAPIを即座に理解させる

Claude Code、Cursor、Windsurf、GitHub Copilotのような最新のAIコーディングツールは、URLから直接ドキュメントを読み取ることができます。私たちは、あなたのAIコーディングアシスタントにmindzieAPIの完全な知識を提供するLLM最適化済みのドキュメントファイルを用意しています。

クイックリファレンス

以下のURLをコピーして、AIコーディングツールの設定に使用してください:

リソース URL おすすめ用途
完全ドキュメント https://docs.mindziestudio.com/llms-full.txt APIの完全理解(約12万トークン)
ドキュメントインデックス https://docs.mindziestudio.com/llms.txt ページリンク付きのクイックリファレンス

Claude Code

Claude CodeはWebFetchまたはカスタムインストラクションを使ってドキュメントにアクセスできます。

方法1:WebFetch(推奨)

Claude Codeのセッション内で完全なドキュメントを取得します:

Please read the mindzieAPI documentation from https://docs.mindziestudio.com/llms-full.txt

ClaudeはAPIドキュメント全体を取得して読み込みます。その後、エンドポイント、認証、リクエスト/レスポンス形式について質問したり、コード例を取得したりできます。

方法2:プロジェクトインストラクションに追加

セッション間で永続的にアクセスするには、プロジェクトのCLAUDE.mdまたは.claude/settings.jsonに以下を追加します:

## mindzieAPI リファレンス

mindzieAPIを扱う際は、以下からドキュメントを取得してください:
https://docs.mindziestudio.com/llms-full.txt

内容は完全なAPIドキュメントを含みます:
- 認証(ベアラー トークン、APIキー)
- 全エンドポイント(テナント、ユーザー、プロジェクト、データセット、ブロック、ダッシュボード)
- リクエスト/レスポンス形式
- 複数言語のコード例

例となるプロンプト

Claudeがドキュメントを取得した後、次のように質問できます:

  • 「mindzieAPIの認証方法は?」
  • 「Pythonで新しいデータセットを作成するコードを書いて」
  • 「ブロックを実行するためのエンドポイントは?」
  • 「プロジェクトにCSVファイルをアップロードする方法を教えて」

Cursor IDE

Cursorは@docs機能を使ってドキュメントをインデックス化し、コーディング時に即座に参照できます。

セットアップ手順

  1. Cursor設定を開く(Cmd/Ctrl + ,)
  2. Features > Docs に移動
  3. Add new docをクリック
  4. URLにhttps://docs.mindziestudio.com/llms-full.txtを入力
  5. 名前をmindzieAPIに設定

使い方

Cursorチャット内でドキュメントを参照します:

@mindzieAPI APIリクエストの認証方法は?
@mindzieAPI テナント内の全プロジェクトをリストアップする関数を書いて

Windsurf

WindsurfはAI支援コーディングのために外部ドキュメントソースをサポートしています。

セットアップ

  1. Windsurfの設定を開く
  2. ナレッジベースまたはドキュメントセクションに移動
  3. https://docs.mindziestudio.com/llms-full.txtを外部ソースとして追加

使い方

コーディング中にWindsurfはmindzieAPIドキュメントを自動参照し、正確な提案や補完を提供します。


GitHub Copilot

CopilotはURLを直接取得しませんが、プロジェクトファイルを通じてコンテキストを提供できます。

オプション1:プロジェクトに含める

プロジェクト内にdocs/mindzieAPI.mdファイルを作成しAPIリファレンスを記述します。Copilotはこのファイルをコンテキストとして利用します。

オプション2:Copilot Chat

GitHub Copilot Chatで、ドキュメントの重要な部分を貼り付けるかURLを参照します:

Using the mindzieAPI documented at https://docs.mindziestudio.com/llms-full.txt,
write a Python class to manage datasets.

Cody(Sourcegraph)

Codyは外部ドキュメントをインデックス化し、コンテキストに基づくアシストを提供します。

セットアップ

  1. Codyの設定を開く
  2. https://docs.mindziestudio.com/llms-full.txtをコンテキストソースに追加
  3. ドキュメントはすべてのコーディングセッションで利用可能になります

一般的なLLM利用法

ChatGPT、Claude webなど任意のLLMインターフェイスで以下が可能です:

  1. まずインデックスを取得: https://docs.mindziestudio.com/llms.txtでドキュメント構造を確認
  2. 完全ドキュメントを取得: https://docs.mindziestudio.com/llms-full.txtの内容をLLMのコンテキストにコピー
  3. 質問を投げる: これでLLMはmindzieAPI全体を理解しています

含まれる内容

LLMドキュメントはmindzieAPI全機能を網羅しています:

カテゴリー 内容
認証 APIキー(グローバル・テナント)、ベアラートークン、スコープ、セキュリティベストプラクティス
テナント マルチテナント管理、作成、更新、削除時の保護措置
ユーザー グローバル操作、テナントスコープ操作、役割と権限
プロジェクト CRUD操作、キャッシュ、ユーザーアクセス、インポート/エクスポート(.mpzファイル)
データセット 作成、CSV/XESインポート、更新、カラムマッピング、ファイル形式
ブロック 分析ブロック、実行、結果取得、ブロックタイプ
ダッシュボード 管理、パネル設定、共有とパブリックURL
エンリッチメント パイプライン、Pythonノートブック連携、実行
アクション 名前付きアクション実行、pingエンドポイント、実行履歴
実行管理 非同期ジョブ管理、キュー操作、ステータストラッキング

コンテキストウィンドウの考慮事項

AIモデルによってコンテキスト制限が異なります。ドキュメントファイルとの適合は以下の通りです:

モデル コンテキスト制限 llms-full.txt対応 推奨
Claude Opus 4 20万トークン 適合(約12万) 完全ドキュメントを使用
Claude Sonnet 20万トークン 適合(約12万) 完全ドキュメントを使用
GPT-4 Turbo 12.8万トークン ぎりぎり適合 完全ドキュメントを使用
GPT-4o 12.8万トークン ぎりぎり適合 完全ドキュメントを使用
Claude Haiku 20万トークン 適合(約12万) 完全ドキュメントを使用
Gemini Pro 12.8万トークン ぎりぎり適合 インデックス+特定ページが必要な場合あり
GPT-3.5 1.6万トークン サイズ大きすぎ インデックス使用後、特定ページ取得推奨

小さいコンテキストウィンドウの場合

モデルのコンテキスト制限が小さい場合は:

  1. llms.txt(インデックス)を使ってAPI構造を理解
  2. 必要なセクションを特定
  3. /docs-master/mindzieAPI/{category}/{page}/page.mdから個別のmarkdownファイルを取得

ファイル形式

URL フォーマット サイズ トークン数
/llms.txt Markdown(インデックス) 約6KB 約1500
/llms-full.txt Markdown(完全版) 約470KB 約12万
/docs-master/.../*.md Markdown(個別ページ) 2〜15KB 約500〜4000

ドキュメントの最新化

LLMドキュメントはAPIドキュメントの更新時に再生成されます。ファイルには最終生成日時のタイムスタンプが含まれています。

最新のドキュメントを使うために、AIツールは無期限にキャッシュせず、都度最新コピーを取得することを推奨します。


MCPサーバー統合

高度なAIツール連携のために、mindzieAPIはMCP(Model Context Protocol)サーバーを提供し、AIアシスタントがmindzieStudioとプログラム的にやり取りできます。

MCPサーバーにはmindzie_list_block_typesのようなツールが含まれており、unifiedカテゴリパラメータで全ブロックタイプ(フィルター、計算機、エンリッチメント)を完全なメタデータ付きで一括取得できます。

MCPサーバードキュメントを見る


次のステップ

AI支援でコーディングを開始する準備ができたら、以下を試してみてください:

  1. AIコーディングツールにhttps://docs.mindziestudio.com/llms-full.txtを設定する
  2. 「mindzieAPIの認証方法は?」と質問する
  3. 「Pythonで全プロジェクトの一覧を出すコードを書いて」と依頼する
  4. AI支援によるコード生成で完全な統合を構築する

人間向けのドキュメントはクイックスタートガイドや完全なAPIリファレンスをご覧ください。