Noveum Api Market MCP Server

🚀 API-Market MCP サーバーガイド

API-Market MCP サーバーは、API の管理や運用を支援するサーバーです。このガイドでは、サーバーのインストール、環境変数の設定、コマンドライン引数の使用方法などを説明します。

🚀 クイックスタート

API-Market MCP サーバーを使用するには、まず必要な依存関係をインストールし、環境変数を設定してからサーバーを起動する必要があります。以下の手順に従って操作してください。

📦 インストール

npm を使用したインストール

必要な依存関係をインストールするには、以下のコマンドを実行します。

npm install

環境変数の設定

サーバーの動作をカスタマイズするために、環境変数を設定します。

• OPENAPI_SPEC_PATH：変更後のファイルを含むパスを指定します（オプション）。
• API_BASE_URL：API のベース URL を設定します（オプション）。
• API_HEADERS：リクエストヘッダーを設定します。例えば：

export API_HEADERS="x-magicapi-key:your-api-key"

実行コマンド

MCP サーバーを起動するには、以下のコマンドを実行します。

npm run build

💻 使用例

環境変数の設定例

- `OPENAPI_SPEC_PATH=modified_files.txt`
- `API_BASE_URL=https://api.magicapi.dev/api/v1/`
- `API_HEADERS="x-magicapi-key:your-api-key"`

コマンドライン引数の使用例

npm run inspect -- \
  --api-base-url https://api.magicapi.dev/api/v1/ \
  --openapi-spec modified_files.txt \
  --headers "x-magicapi-key:your-api-key" \
  --name "my-mcp-server" \
  --version "1.0.0"

🔧 開発モード

開発環境の起動

開発サーバーを起動するには、以下のコマンドを実行します。

npm run inspect-watch

コードの変更

src/ ディレクトリ内の TypeScript ファイルを変更すると、サーバーは自動的に再構築され、再起動します。

デバッグツールの使用

• MCP チェッカー画面を使用して変更をテストします。
• ブラウザから http://localhost:9001 にアクセスします。

🤝 コントリビューションガイド

コードの提出

1. リポジトリを Fork します。
2. 機能ブランチを作成します。
3. 変更をコミットします。
4. テストとチェックを実行します。

npm run typecheck
npm run lint

5. Pull Request を提出します。

リリースガイド（オプション）

新しいバージョンをリリースする場合は、以下の手順を実行します。

• package.json 内の関連情報を更新します。
• パッケージを公開します。

npm publish --access public

📄 ライセンス

このプロジェクトは MIT ライセンスの下で提供されています。