mcpyammy-npm

mcpyammy

MCP (Model Context Protocol) サーバー設定をYAMLで管理するCLIツール

特徴

• 🚀 高速処理: TypeScriptで実装された高速なYAML処理
• 🔒 セキュリティ重視: パストラバーサル攻撃対策と安全なパス検証
• 🎨 使いやすいUI: インタラクティブなCLIとカラフルな出力
• 📦 NPMパッケージ: 簡単にインストールして使用可能
• 🧪 テストカバレッジ: 80%以上のテストカバレッジ

インストール

npm install -g mcpyammy

または、ローカルインストール:

npm install mcpyammy

使用方法

インタラクティブモード

引数なしで実行すると、インタラクティブモードが起動します:

mcpyammy

コマンドラインモード

設定の適用

YAMLファイルからMCPサーバー設定を適用します:

mcpyammy apply config.yaml

設定のインポート

既存のJSONファイルをYAML形式に変換します:

mcpyammy import mcp.json

設定のプレビュー

YAMLファイルの内容をプレビューします:

mcpyammy preview config.yaml

YAML設定ファイル例

- name: "example-server"
  command: "node"
  args:
    - "server.js"
    - "--port"
    - "3000"
  env:
    NODE_ENV: "production"
    API_KEY: "your-api-key"
  extra:
    timeout: 30
    retries: 3

セキュリティ

このツールは以下のセキュリティ対策を実装しています:

• パス検証: ホームディレクトリ外へのアクセスを防止
• サイズ制限: YAMLファイルのサイズを1MB以内に制限
• 構造検証: YAMLのネスト階層を50レベル以内に制限
• ファイル権限: 設定ファイルに適切な権限を設定 (0600)

開発

必要条件

• Node.js 18.0.0 以上
• npm または yarn

セットアップ

git clone <repository-url>
cd mcpyammy
npm install

ビルド

npm run build

テスト

npm test

リンティング

npm run lint

API

プログラムから使用する場合:

import { ConfigProcessor } from 'mcpyammy';

const processor = new ConfigProcessor();
const servers = await processor.loadAndValidateYAML('config.yaml');
await processor.processClients(servers);

詳細なAPIドキュメントは API.md を参照してください。

貢献

• このリポジトリをフォーク
• 機能ブランチを作成 (git checkout -b feature/amazing-feature)
• 変更をコミット (git commit -m 'Add amazing feature')
• ブランチをプッシュ (git push origin feature/amazing-feature)
• Pull Requestを作成

ライセンス

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

変更履歴

詳細な変更履歴は CHANGELOG.md を参照してください。

サポート

バグ報告や機能リクエストは GitHub Issues までお願いします。