Onx MCP Server

🚀 Onspring MCP サーバー

モデルコンテキストプロトコル (MCP) サーバーの実装で、Onspring API と統合されています。これにより、AI アシスタントが Onspring インスタンスに保存されているデータにアクセスし、操作することができます。

🚀 クイックスタート

Onspring MCP サーバーは、AI アシスタントと Onspring インスタンスの間の橋渡しを行います。モデルコンテキストプロトコルを通じて、アプリケーションの情報取得やデータ操作などの機能を提供します。

✨ 主な機能

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

📦 インストール

前提条件

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

インストール手順

1. グローバルにパッケージをインストールする：

npm install -g onx-mcp-server

または、npx を直接使用する：

npx onx-mcp-server

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

# リポジトリをクローンする
git clone https://github.com/your-username/onx-mcp-server.git
cd onx-mcp-server

# 依存関係をインストールする
npm install

# プロジェクトをビルドする
npm run build

# サーバーを起動する
npm start

💻 使用例

基本的な使用法

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

📚 ドキュメント

設定

サーバーは以下の環境変数が設定されていることを要求します。

Claude Desktop への接続

Claude Desktop は人気の MCP クライアントです。Onspring MCP サーバーを Claude Desktop に接続するには、以下の手順に従ってください。

1. claude_desktop_config.json ファイルを見つけます。このファイルを見つける方法の詳細については、Claude Desktop ユーザー向け のドキュメントを参照してください。
2. テキストエディタで claude_desktop_config.json ファイルを開き、以下の内容を追加します。

{
  "servers": [
    {
      "url": "http://localhost:3001"
    }
  ]
}

開発

開発環境のセットアップ

# 依存関係をインストールする
npm install

# 開発モードで実行する（変更を監視する）
npm run dev

テスト

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

# テストを実行する
npm test

# カバレッジ付きでテストを実行する
npm run test:coverage

# UI 付きでテストを実行する
npm run test:ui

サーバーのチェック

MCP モニターを使用してサーバーをテストすることができます。

npm run inspect

📄 ライセンス

このプロジェクトは MIT License の下で公開されています。詳細は LICENSE.md ファイルを参照してください。