Nile MCP Server

🚀 Nile MCP サーバー開発ドキュメント

Nile MCP サーバーは、Model Context Protocol (MCP) に基づくツールサーバーです。主に Nile データベースとのやり取りを実現するために使用されます。このサーバーは、データベース管理、接続文字列生成、SQL クエリ実行などの一連の機能を提供します。

🚀 クイックスタート

インストールと起動

1. プロジェクトリポジトリをクローンします：

git clone https://github.com/your-repository.git
cd nile-mcp-server

2. 依存関係をインストールします：

npm install

3. 開発サーバーを起動します：

npm run dev

主要ツール

• データベース管理

  • データベースを作成する：POST /api/databases
  • データベースを一覧する：GET /api/databases
  • データベースの詳細を取得する：GET /api/databases/:id
  • データベースを削除する：DELETE /api/databases/:id

• 接続文字列生成

  • 接続文字列テンプレートを取得する：GET /api/connection-strings/template
  • 有効な接続文字列を生成する：POST /api/connection-strings

✨ 主な機能

• 多言語対応: TypeScript で実装されており、複数のプログラミング言語と互換性があります。
• モジュール化設計: プラグイン式アーキテクチャを採用しており、拡張と保守が容易です。
• 高可用性: クラスターデプロイと負荷分散をサポートしており、サービスの安定稼働を保証します。
• セキュリティ機構: 認証と権限管理が統合されており、データの安全性を保障します。

💻 使用例

基本的な使用法

// 新しいデータベースを作成する
const response = await fetch('/api/databases', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'my-database',
    region: 'aws-us-west-2'
  })
});

// すべてのデータベースを取得する
const databases = await fetch('/api/databases').then(response => response.json());

📚 ドキュメント

プロジェクト構造

nile-mcp-server/
├── src/
│   ├── server.ts      # メインサーバー実装ファイル
│   ├── tools.ts       # ツール実装モジュール
│   ├── types.ts       # 型定義ファイル
│   ├── logger.ts      # ログツールライブラリ
│   └── index.ts       # エントリープログラム
├── dist/             # コンパイル後の JavaScript ファイル
├── logs/            # ログフォルダ
├── .env             # 環境変数設定
├── .gitignore       # Git 無視ファイル
├── package.json     # プロジェクト依存関係管理
└── tsconfig.json    # TypeScript 設定ファイル

重要なファイルの説明

• server.ts: サーバーの起動、ツールの登録、メッセージの送受信処理を担当します。
• tools.ts: すべてのデータベース操作と SQL クエリの実行ロジックを実装します。
• types.ts: データベース操作に関連するインターフェースと応答形式を定義します。
• logger.ts: 構造化されたログ記録機能を提供し、毎日のローテーションとデバッグモードをサポートします。
• index.ts: サーバーの起動エントリーファイルです。

スクリプトの使用

プロジェクトでは以下の npm スクリプトが提供されています：

# TypeScript コードをコンパイルする
npm run build

# 本番環境用サーバーを起動する
npm start

# 開発モードで実行し、自動再構築をサポートする
npm run dev

# テストスイートを実行する
npm test

# ESLint を実行してコード品質をチェックする
npm run lint

# ビルド生成物をクリーンアップする
npm run clean

貢献ガイド

• コードスタイル: Airbnb JavaScript Style Guide に従ってください。
• コミット規則: Conventional Commits 形式を使用してください。
• 協力フロー: Git Flow ブランチ戦略を使用することをお勧めします。

🔧 技術詳細

プラグイン開発

Tool クラスを拡張することで、カスタムツールを作成することができます：

class MyCustomTool implements Tool {
  async execute(command: string, args: any[]) {
    // カスタムロジックの実装
  }
}

セキュリティに関する注意事項

• 認証: JWT または OAuth2 を使用してユーザー認証を行います。
• 権限管理: ロールベースのアクセス制御（RBAC）を使用して、リソース操作を制限します。
• データ暗号化: 機密データを暗号化して、転送と保存の安全性を確保します。

ドキュメントの履歴

• v1.0.0: 基本機能を含む初期バージョンがリリースされました。
• v2.0.0: プラグインメカニズムと多言語対応が導入されました。
• v3.0.0: 高可用性クラスターのサポートが追加された最新バージョンがリリースされました。

貢献者

• [Your Name] - プロジェクトメンテナ
• [Contributor Name] - 核心開発メンバー

📄 ライセンス

このプロジェクトは MIT ライセンスに従っており、詳細は LICENSE ファイルを参照してください。