Onx Mcp Server

Onspring MCP Server

Onspring の API と統合する Model Context Protocol（MCP）サーバーの実装です。AI アシスタントが Onspring インスタンスに保存されたデータへアクセスし、操作できるようにします。

説明

このサーバーは、Model Context Protocol を介して AI アシスタントと Onspring インスタンスをつなぎます。MCP クライアントが Onspring のデータを読み取り、操作できるようにし、次のような機能を提供します。

• アプリとそのフィールドの一覧を取得する
• アプリからレコードを取得する
• アプリに対してクエリを実行する
• レポートデータにアクセスする
• 添付フィールドからファイルを取得する

目次

• インストール
• 使用方法
• 設定
• 利用可能なツール
• 開発
• ライセンス

インストール

前提条件

• Node.js
• API アクセス権のある Onspring インスタンス
• 適切な権限を持つ Onspring API キー

インストール手順

1. パッケージをグローバルにインストールします。

npm install -g @stevanfreeborn/onx-mcp-server

または、npx から直接使用します。

npx @stevanfreeborn/onx-mcp-server

ソースからのビルド

ソースからビルドする場合：

# Clone the repository
git clone https://github.com/your-username/onx-mcp-server.git
cd onx-mcp-server

# Install dependencies
npm install

# Build the project
npm run build

# Start the server
npm start

使用方法

このサーバーを使用するには、使用する MCP クライアントで設定する必要があります。各 MCP クライアントには、MCP サーバーの設定方法が説明されています。また、必要な環境変数が設定されていることを確認してください。詳細については、設定セクションを参照してください。

設定

サーバーを使用するには、次の環境変数を設定する必要があります。

変数	説明	デフォルト
ONSPRING_API_KEY	Onspring API キー	（必須）
ONSPRING_BASE_URL	Onspring API のベース URL	https://api.onspring.com

Claude Desktop への接続

Claude Desktop は広く利用されている MCP クライアントです。Onspring MCP サーバーを Claude Desktop に接続するには、次の手順に従ってください。

1. claude_desktop_config.json ファイルを見つけます。このファイルの場所について詳しくは、こちらのドキュメントを参照してください：Claude Desktop ユーザー向け。

2. テキストエディターで claude_desktop_config.json ファイルを開き、次の設定を追加します。

{
  "mcpServers": {
    "onx-mcp-server": {
      "command": "npx",
      "args": ["-y", "@stevanfreeborn/onx-mcp-server"],
      "env": {
        "ONSPRING_API_KEY": "your_onspring_api_key",
        "ONSPRING_BASE_URL": "https://api.onspring.com"
      }
    }
  }
}

メモ

コマンドと引数は、環境によって異なる場合があります。

利用可能なツール

MCP Server は、AI アシスタントが Onspring を操作するために、次のツールを公開します。

checkConnectionTool

指定された認証情報を使用して、サーバーが Onspring API に接続できることを確認します。

getAppsTool

Onspring インスタンスでアクセス可能なすべてのアプリの一覧を取得します。

getFieldsTool

指定したアプリのすべてのフィールドを取得します。

パラメーター：

• name：アプリの名前

getRecordsTool

指定したフィールドを含む、アプリのレコードを取得します。

パラメーター：

• appName：アプリの名前
• fields：取得するフィールド名の配列
• pageNumber：取得開始ページの番号（1 始まり）
• numberOfPages：取得するページ数

getReportsTool

指定したアプリで利用可能なすべてのレポートを取得します。

パラメーター：

• appName：アプリの名前

getReportDataTool

指定したレポートのデータを取得します。

パラメーター：

• appName：アプリの名前
• reportName：レポートの名前
• dataType：取得するレポートデータの種類（任意）

queryRecordsTool

フィルターを使用して、アプリのレコードをクエリします。

パラメーター：

• appName：アプリの名前
• fields：取得するフィールド名の配列
• filter：結果を絞り込むフィルターオブジェクト
• pageNumber：取得開始ページの番号（1 始まり）
• numberOfPages：取得するページ数

getFileTool

添付フィールドに保存されているファイルを取得します。

パラメーター：

• appName：アプリ名
• fieldName：添付フィールド名
• recordId：ファイルを含むレコードの ID
• fileName：取得するファイル名

開発

開発環境のセットアップ

# Install dependencies
npm install

# Run in development mode (watches for changes)
npm run dev

テスト

このプロジェクトではテストに Vitest を使用しています。

# Run tests
npm test

# Run tests with coverage
npm run test:coverage

# Run tests with UI
npm run test:ui

サーバーの検査

MCP Inspector を使用してサーバーをテストできます。

npm run inspect

ライセンス

このプロジェクトは MIT License の下でライセンスされています。詳細については、LICENSE.md ファイルをご覧ください。