openapi-mcp

openapi-mcpは、OpenAPI 3.x仕様を迅速にMCPツールサーバーに変換するツールです。APIの仕様を検証し、各操作に対するMCPツールを生成し、標準入出力またはHTTPを介して機械可読な出力を提供します。これにより、AIエージェントとの統合が容易になります。

GitHubスター

68

ユーザー評価

未評価

お気に入り

0

閲覧数

26

フォーク

14

イシュー

0

インストール方法
難易度
中級
推定所要時間
10-20
必要な環境
Go: 1.21 or higher

インストール方法

インストール方法

前提条件

必要なソフトウェアとバージョンを明記してください。
Go: 1.21以上

インストール手順

1. リポジトリのクローン

bash
git clone https://github.com/jedisct1/openapi-mcp.git
cd openapi-mcp

2. 依存関係のインストール

bash
go mod tidy

3. サーバーのビルド

bash
go build

4. サーバーの起動

bash
./openapi-mcp --spec path/to/openapi.yaml

トラブルシューティング

よくある問題

問題: サーバーが起動しない 解決策: Goのバージョンを確認し、依存関係を再インストールしてください。 問題: OpenAPI仕様が正しくない 解決策: YAML/JSONファイルを再確認し、正しい形式であることを確認してください。

設定方法

設定方法

基本設定

MCPサーバーを起動するための基本的な設定は必要ありませんが、OpenAPI仕様ファイルのパスを指定する必要があります。

設定例

OpenAPI仕様ファイルの指定

bash
./openapi-mcp --spec path/to/openapi.yaml

環境変数

必要に応じて以下の環境変数を設定:
bash
export MCP_SERVER_PORT=3000

詳細設定

セキュリティ設定

APIキーは環境変数または安全な設定ファイルに保存
ファイルアクセス権限の適切な設定

使用例

使用例

基本的な使用方法

MCPサーバーの基本的な使用方法を以下に示します:

MCPサーバーの起動

bash
./openapi-mcp --spec path/to/openapi.yaml

プログラムでの使用

go
package main

import (
	"fmt"
	"github.com/jedisct1/openapi-mcp/pkg/openapi2mcp"
)

func main() {
	result, err := openapi2mcp.CallTool("toolName", map[string]interface{}{
		"parameter1": "value1",
		"parameter2": "value2",
	})
	if err != nil {
		fmt.Println(err)
	}
	fmt.Println(result)
}

使用ケース

API仕様をMCPツールに変換し、AIエージェントと連携させることで、開発プロセスを効率化。
OpenAPI仕様の検証を行い、エラーを早期に発見して修正。
HTTPサーバーモードを使用して、外部アプリケーションからAPIを呼び出す。
CLIツールとして利用し、スクリプトからAPI操作を自動化。