IB API Documentation

IB API ドキュメント

Postman コレクションからドキュメントを取得し、AI アクションを生成するための Model Context Protocol（MCP）サーバーです。

機能

• Postman コレクションの一覧表示と検索
• コレクション構造のナビゲート
• リクエストの詳細情報の取得 | - 包括的なレスポンス例の処理： | - 利用可能なレスポンス例の一覧表示 | - リクエストの詳細情報の取得（リクエスト情報に重点） | - レスポンス例の詳細情報の取得 | - 例データにアクセスするための効率的なワークフロー
• Postman リクエストからのコードアクションの生成
• 複数の AI フレームワークとのオプションの連携
• TypeScript/JavaScript コードの生成

ドキュメント

• API リファレンス - サーバーツールとデータ構造の詳細情報
• 設定ガイド - サーバーのセットアップと設定オプション
• プロンプトテンプレート - ツールを使用するための例とテンプレート
• 更新手順 - MCP サーバーのインストールを更新する方法

インストール

1. リポジトリをクローンします：

git clone https://github.com/ibproduct/ib-api-doc.git
cd ib-api-doc

2. 依存関係をインストールします：

npm install

3. サーバーをビルドします：

npm run build

4. 設定ガイドに従ってサーバーを設定します

使用方法

詳しい使用方法と例については、プロンプトテンプレートガイドを参照してください。

開発

開発ワークフロー

1. 開発環境をセットアップします：

# Clone and set up the repository
git clone https://github.com/ibproduct/ib-api-doc.git
cd ib-api-doc
npm install

2. 開発サーバーを設定します：

• MCP 設定ファイルに開発用の設定を作成します
• ローカルの開発ビルドを指定します
• すべてのツールを alwaysAllow 配列に含めます

3. 開発サイクル：

# Make code changes
npm run build  # Build the changes
# Reload VSCode window to pick up new build
# Test using the development server configuration
# Repeat until satisfied with changes

4. コミットする前に：

• 影響を受けるすべての機能をテストします
• 必要に応じてドキュメントを更新します
• 以下の Git ワークフローに従います

Git ワークフロー

1. 開発を始める前に：

git pull origin main
npm install  # If dependencies have changed

2. 開発中：

• .gitignore ファイルでは、以下を除外するよう設定されています：
  • ビルド成果物（build/、dist/）
  • 依存関係（node_modules/）
  • 環境ファイル（.env*）
  • IDE ファイル（.vscode/、.idea/）
  • ログとデバッグファイル
  • システムファイル（.DS_Store、Thumbs.db）

3. 変更をコミットします：

git add .  # Stage changes (respects .gitignore)
git commit -m "type: description

- Bullet points for specific changes
- Another change"

4. 変更をプッシュします：

git pull origin main  # Get latest changes
git push origin main  # Push your changes

開発サーバー

自動リロードを有効にして、開発モードでサーバーを実行するには：

npm run watch

サーバーの機能を確認するには：

npm run inspector

ライセンス

非公開 - IntelligenceBank © 2024