Webapi MCP Server

🚀 WebAPI を MCP に変換するツール

このツールは、Web API を MCP に変換するためのガイドです。簡単な設定で様々な Web API を登録・管理し、統一的に呼び出すことができます。

🚀 クイックスタート

このツールを使用するには、まず npm パッケージをインストールする必要があります。

npm install webapi-mcp-server

✨ 主な機能

これは Web API を MCP に変換するためのモジュールです。簡単な設定で様々な Web API を登録・管理し、統一的に呼び出すことができます。

📦 インストール

このツールを使用するには、npm パッケージをインストールする必要があります。

npm install webapi-mcp-server

💻 使用例

基本的な使用法

サーバーの作成

webapi.createServer 関数を使用してカスタムサーバーを作成します。

const webapi = require('webapi-mcp-server');

// 基本サーバーの作成
const server = webapi.createServer({
  debug: true, // デバッグモードを有効にする
  configFile: './config.json', // 設定ファイルのパス
  apisDir: './apis' // API 定義のディレクトリ
});

// リスニングを開始する
server.listen(3000);

API の登録

registerApi メソッドを使用して単一の API を登録します。

webapi.registerApi({
  name: 'weather', // 一意の名前
  description: '天気情報を取得する', // 説明
  url: 'https://api.example.com/weather', // リクエスト URL
  method: 'GET' // HTTP メソッド
});

パラメータの使用

API 定義には、リクエストパラメータを含めることができます。

webapi.registerApi({
  name: 'weather',
  parameters: {
    city: {
      type: 'string',
      required: true,
      description: '都市名'
    },
    units: {
      type: 'string',
      required: false,
      description: '温度単位 (celsius, fahrenheit)'
    }
  }
});

レスポンスの処理

resultPath フィールドを使用して結果を抽出する方法を指定します。

webapi.registerApi({
  name: 'weather',
  resultPath: 'data.current' // 結果のパス、例: "data.items"
});

リクエストヘッダーの設定

API 定義にリクエストヘッダー情報を追加します。

webapi.registerApi({
  name: 'news',
  headers: {
    'X-API-Key': 'your-key'
  }
});

JSON 形式の定義例

完全な API 定義の例を以下に示します。

{
  "name": "weather",
  "description": "天気情報を取得する",
  "url": "https://api.example.com/weather",
  "method": "GET",
  "parameters": {
    "city": {
      "type": "string",
      "required": true,
      "description": "都市名"
    }
  },
  "headers": {
    "X-API-Key": "your-key"
  },
  "resultPath": "data.current"
}

Markdown 形式の定義例

完全な API 定義は、Markdown 形式でも記述できます。

# Weather API

天気情報を取得する

## URL
https://api.example.com/weather

## メソッド
GET

## パラメータ
- city (string, required): 都市名

## リクエストヘッダー
- X-API-Key: your-key

## 結果のパス
data.current

API の呼び出し例

API を呼び出す例を以下に示します。

const result = await webapi.call('weather', {
  city: 'London'
});
console.log(result);

モジュールのエクスポート

関数をエクスポートすることで、機能を拡張することができます。

module.exports = {
  customFunction: function() {}
};

📚 ドキュメント

• 詳細ドキュメント
• サンプルプロジェクト

📄 ライセンス

このプロジェクトは MIT ライセンスに従います。