Opyconymcpy

🚀 OpCon MCP Server

OpCon MCP Serverは、Model Context Protocol (MCP)を使用してSMA OpCon REST APIとやり取りするためのサーバーです。このサーバーにより、AIエージェントやアプリケーションが標準化されたプロトコルを通じてOpCon自動化プラットフォームとやり取りできるようになります。

🚀 クイックスタート

このサーバーを使用するには、以下の前提条件を満たす必要があります。

• Node.js 18以上
• OpCon APIサーバーへのアクセス
• OpCon APIの認証情報（トークンまたはユーザー名とパスワード）

インストール方法は以下の通りです。

npm install

サーバーの起動方法は以下の通りです。

# 開発モード
npm run dev

# 本番モード（ビルド後）
npm run build
node dist/index.js

✨ 主な機能

• ✅ 完全なAPIカバレッジ：OpenAPI仕様から自動的にMCPツールを生成します。
• ✅ 認証サポート：トークンベースおよびユーザー名/パスワード認証をサポートします。
• ✅ 型安全性：TypeScriptで記述され、完全な型定義があります。
• ✅ 包括的なテスト：Jestを使用した単体テストがあります。
• ✅ CI/CD：テスト、リント、セキュリティのためのGitHub Actionsワークフローがあります。
• ✅ 開発ツール：DevContainerとVSCodeの統合がサポートされています。
• ✅ ベストプラクティス：ESLint、Prettier、セキュリティスキャンが実装されています。
• ✅ Grafanaサポート：監視と可観測性のためのPrometheusメトリクスがサポートされています。

📦 インストール

npm install

📚 ドキュメント

完全なドキュメントを表示 - 以下を含む完全なガイドです。

• クイックスタートガイド - 数分で始めることができます。
• ツールリファレンス - 詳細なパラメータを持つ257の利用可能なツールすべてが記載されています。
• 設定ガイド - 環境設定について説明しています。
• 統合ガイド - MCPクライアントの統合方法について説明しています。
• サンプル - 使用例が記載されています。

🔧 技術詳細

構成

サーバーは環境変数を介して構成されます。

*OPCON_TOKENまたはOPCON_USERNAMEとOPCON_PASSWORDの両方が必要です。

アーキテクチャ

MCPサーバーのアーキテクチャは以下の要素で構成されています。

1. パーサー：OpenAPI仕様を読み取り、MCPツール定義を生成します。
2. クライアント：OpCon APIとのHTTP通信を処理し、認証も含みます。
3. サーバー：MCPプロトコルを実装し、ツール呼び出しを適切なAPIエンドポイントにルーティングします。

フロー

MCP Client → MCP Server → OpCon Client → OpCon REST API

💻 使用例

サーバーの実行

# 開発モード
npm run dev

# 本番モード（ビルド後）
npm run build
node dist/index.js

MCPクライアントでの使用

MCPクライアント（例：Claude Desktop、MCP Inspector）をこのサーバーを使用するように構成します。

{
  "mcpServers": {
    "opcon": {
      "command": "node",
      "args": ["/path/to/OpyConyMcpy/dist/index.js"],
      "env": {
        "OPCON_BASE_URL": "https://your-opcon-server:9010",
        "OPCON_TOKEN": "your-token-here"
      }
    }
  }
}

利用可能なツール

サーバーはOpCon OpenAPI仕様から自動的にMCPツールを生成します。各APIエンドポイントは呼び出し可能なツールになります。

65のカテゴリにまたがる257のツール があり、以下のようなものが含まれます。

• DailyJobs（40のツール） - 日次ジョブの実行を監視および管理します。
• DailySchedules（11のツール） - 日次スケジュールの操作を行います。
• Machines（10のツール） - マシンの構成と監視を行います。
• Calendars（8のツール） - カレンダーの管理を行います。
• AccessCodes（5のツール） - アクセスコードの管理を行います。
• Resources（5のツール） - リソースの管理を行います。
• その他59のカテゴリ...

完全なリストについては、ツールリファレンスを参照してください。

開発

セットアップ

# 依存関係のインストール
npm install

# 開発モードで実行
npm run dev

テスト

# すべてのテストを実行
npm test

# ウォッチモードでテストを実行
npm run test:watch

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

リントとフォーマット

# ESLintを実行
npm run lint

# ESLintの問題を修正
npm run lint:fix

# フォーマットをチェック
npm run format:check

# フォーマットを修正
npm run format

ビルド

npm run build

Grafanaでの監視

OpCon MCP Serverは、Grafanaで可視化できるPrometheusメトリクスをサポートしています。

クイックスタート

1. メトリクス収集を有効にします。

export OPCON_METRICS_ENABLED=true

2. メトリクスHTTPサーバーを起動します。

# 開発モード
npm run dev:metrics

# 本番モード（ビルド後）
node dist/metrics-server.js

3. http://localhost:9090/metricsでメトリクスにアクセスします。

利用可能なメトリクス

• リクエスト数：ツールとメソッドごとの総MCPツールリクエスト数
• エラー率：ツール、メソッド、エラータイプごとのエラー数
• リクエスト時間：p95、p99パーセンタイルを含むレイテンシヒストグラム
• 利用可能なツール：登録されたMCPツールの数

Grafanaダッシュボードの設定

1. Prometheusを設定してメトリクスエンドポイントをスクレイピングします。
2. grafana/dashboard.jsonからダッシュボードをインポートします。
3. GrafanaでPrometheusデータソースを構成します。

詳細な手順については、grafana/README.mdを参照してください。

DevContainerサポート

このプロジェクトにはVS Code用のDevContainer構成が含まれています。使用するには以下の手順を実行します。

1. DockerとVS Codeをインストールします。
2. Remote - Containers拡張機能をインストールします。
3. VS Codeでプロジェクトを開きます。
4. プロンプトが表示されたら「コンテナーで再開」をクリックします。

VS Code統合

このプロジェクトにはVS Codeの設定と推奨拡張機能が含まれています。

• ESLint：コードのリントを行います。
• Prettier：コードのフォーマットを行います。
• Jest Runner：エディターからテストを実行できます。
• TypeScript：強化されたTypeScriptサポートがあります。

CI/CD

GitHub Actionsワークフローは以下の目的で構成されています。

• CI：複数のNode.jsバージョンでのリント、テスト、ビルド
• セキュリティ：CodeQL分析、依存関係レビュー、npm監査

プロジェクト構造

OpyConyMcpy/
├── .devcontainer/          # DevContainer構成
├── .github/
│   └── workflows/          # GitHub Actionsワークフロー
├── .vscode/                # VS Code設定
├── src/
│   ├── index.ts           # メインサーバーエントリーポイント
│   ├── client.ts          # OpCon APIクライアント
│   ├── parser.ts          # OpenAPI仕様パーサー
│   └── types.ts           # 型定義
├── tests/                  # 単体テスト
├── swagger.json           # OpCon OpenAPI仕様
├── package.json           # プロジェクト依存関係
├── tsconfig.json          # TypeScript構成
├── jest.config.js         # Jest構成
├── .eslintrc.json         # ESLint構成
└── .prettierrc            # Prettier構成

コントリビュート

1. リポジトリをフォークします。
2. 機能ブランチを作成します。
3. 変更を加えます。
4. テストとリントを実行します。
5. プルリクエストを送信します。

セキュリティ

• 本番環境では常にHTTPSを使用してください。
• 認証情報を安全に保管してください（環境変数を使用し、コミットしないでください）。
• 絶対に必要な場合を除き、TLS検証を有効にしてください。
• 依存関係を定期的に更新してください。
• GitHub Actionsでのセキュリティスキャン結果を確認してください。

📄 ライセンス

MIT

サポート

問題や質問については、GitHubのイシュートラッカーを使用してください。