Postgresql MCP Server

🚀 PostgreSQL MCP サーバー

このサーバーは、PostgreSQL データベースの管理機能を提供する Model Context Protocol (MCP) サーバーです。既存の PostgreSQL 設定を分析し、実装のガイダンスを提供し、データベースの問題をデバッグするのに役立ちます。

🚀 クイックスタート

この PostgreSQL MCP サーバーを使用することで、PostgreSQL データベースの分析、インストールガイダンス、デバッグなどの機能を利用できます。以下のセクションで各機能の詳細を説明します。

✨ 主な機能

1. データベース分析 (analyze_database)

PostgreSQL データベースの構成とパフォーマンス指標を分析します。

• 構成分析
• パフォーマンス指標
• セキュリティ評価
• 最適化提案

// 利用例
{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "analysisType": "performance" // オプション: "configuration" | "performance" | "security"
}

2. インストールガイド (get_setup_instructions)

PostgreSQL のインストールと構成に関する手順を提供します。

• プラットフォーム固有のインストール手順
• 構成推奨事項
• セキュリティのベストプラクティス
• インストール後のタスク

// 利用例
{
  "platform": "linux", // 必須: "linux" | "macos" | "windows"
  "version": "15", // オプション: PostgreSQL のバージョン
  "useCase": "production" // オプション: "development" | "production"
}

3. データベースデバッグ (debug_database)

PostgreSQL の一般的な問題をデバッグします。

• 接続問題
• パフォーマンスのボトルネック
• ロックの競合
• レプリケーションの状態

// 利用例
{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "issue": "performance", // 必須: "connection" | "performance" | "locks" | "replication"
  "logLevel": "debug" // オプション: "info" | "debug" | "trace"
}

📦 インストール

前提条件

• Node.js >= 18.0.0
• PostgreSQL サーバー（対象データベースの操作）
• 対象 PostgreSQL インスタンスへのネットワークアクセス

Smithery を通じたインストール

Smithery を通じて自動的にインストールするには、以下のコマンドを実行します。

npm install -g @nahmanmate/postgresql-mcp-server

手動インストール

リポジトリをクローンして以下のコマンドを実行します。

git clone https://github.com/nahmanmate/postgresql-mcp-server.git
cd postgresql-mcp-server
npm install
npm start

💻 使用例

基本的な使用法

try {
  const result = await postgresqlMCPService.analyzeDatabase({
    connectionString: "postgresql://user:password@localhost:5432/dbname",
    analysisType: "performance"
  });
  console.log(result);
} catch (error) {
  console.error("エラーが発生しました：", error.message);
}

🔧 技術詳細

開発

開発環境をセットアップするには、以下のコマンドを実行します。

git clone https://github.com/nahmanmate/postgresql-mcp-server.git
cd postgresql-mcp-server
npm install
npm run dev

セキュリティに関する考慮事項

• PostgreSQL サーバーのセキュリティ構成を確保する
• 強力なパスワードとアクセス制御を使用する
• 定期的にデータベースをバックアップする
• パフォーマンスとエラーを監視する

ベストプラクティス

• 接続プールを使用してデータベース接続を管理する
• 適切なクエリタイムアウトを設定する
• ロールベースのアクセス制御を使用する
• ログ記録と監視を有効にする

📄 ライセンス

MIT License

Copyright (c) 2024 nahmanmate

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

🤝 貢献ガイド

コードに貢献するには、リポジトリをフォークしてメインブランチに変更を提出してください。