Sql Server Table Assistant

## 🚀 SQL Server 自然言語クエリツール使用ドキュメント

このプロジェクトは、Microsoftの [Modal Context Protocol (MCP)](https://github.com/microsoft/mcp) に基づいており、[Aman Pachori](https://github.com/Amanp17) によって最初に実装されました。自然言語処理技術を使って、SQL Serverデータベースの操作を簡素化することを目的としています。ユーザーは中国語で質問することができ、ツールが自動的に対応するSQLクエリを生成して実行します。

## 🚀 クイックスタート

このツールを使用するには、まず環境設定とツールの構成を行う必要があります。以下の手順に従って設定を行ってください。

## ✨ 主な機能

### コア機能
- **自然言語クエリ**：ユーザーが中国語で質問すると、ツールが自動的にSQLクエリを生成します。
- **結果の説明**：ツールは結果を中国語で説明し、ユーザーがデータを理解しやすくします。
- **クエリ履歴**：実行されたすべてのクエリを記録し、トレースと管理を容易にします。

### 特殊コマンド
- `/diagnose`：全面的なテーブルアクセス診断を実行します。
- `/refresh_schema`：テーブル構造情報を更新します。
- `/history`：現在のセッション内のすべてのクエリ記録を表示します。

## 📦 インストール

### 環境要件
- **オペレーティングシステム**：Windows 10以上
- **.NET Framework**：バージョン4.7.2以上
- **ODBCドライバ**：Microsoft ODBC Driver for SQL Serverをインストールする必要があります。

### 設定手順
1. [Microsoft ODBC Driver for SQL Server](https://www.microsoft.com/en-us/download/details.aspx?id=50984) をダウンロードしてインストールします。
2. 構成ファイル `config.json` を作成し、以下の情報を記入します。
   ```json
   {
     "Server": "あなたのサーバーアドレス",
     "Database": "あなたのデータベース名",
     "UID": "あなたのログイン名",
     "PWD": "あなたのパスワード"
   }

3. config.json をツールのルートディレクトリに配置します。

💻 使用例

基本的な使用法

> 显示所有薪资超过50000的员工信息。
SQLクエリ生成: SELECT EmployeeName, Department, Salary FROM dbo.Employees WHERE Salary > 50000 ORDER BY Salary DESC;
実行成功。結果は以下の通りです。
+----------------+-------------+------+
| 员工姓名       | 部门       | 工资  |
|----------------+------------+------|
| 张三          | 技术部     | 60000 |
| 李四          | 人力资源部 | 55000 |
| 王五          | 市场部     | 70000 |
+----------------+-------------+------+
結果の説明：以下は給与が50000を超えるすべての従業員で、給与の降順で並べられています。王五が最も高い給与を得ています。

> 显示每个部门的最高薪资。
SQLクエリ生成: SELECT Department, MAX(Salary) AS MaxSalary FROM dbo.Employees GROUP BY Department;
実行成功。結果は以下の通りです。
+------------+-----------+
| 部门       | 最高薪资  |
|------------+-----------|
| 技术部     | 80000     |
| 人力资源部 | 65000     |
| 市场部     | 75000     |
+------------+-----------+
結果の説明：技術部の最高給与は80000元で、張三が得ています。市場部の最高給与は75000元で、王五が得ています。

🔧 技術詳細

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

1. 単一テーブルアクセス：クエリは構成されたテーブル内に厳密に制限されます。
2. クエリ検証：すべてのSQLクエリは実行前にユーザーに表示され、操作の安全性を確保します。
3. トランザクションの安全性：更新、挿入、削除操作はロールバック付きのトランザクションを使用し、データの整合性を保証します。
4. エラーログ：エラー情報を詳細に記録し、問題のトラブルシューティングを容易にし、機密情報を漏洩しません。
5. SQLインジェクションの防止：構造化されたクエリ生成メカニズムにより、SQLインジェクションのリスクを低減します。

ログと記録

すべてのクエリとその結果は自動的に logs/queries/ フォルダに保存されます。各ログファイルには以下の情報が含まれます。

• 元の自然言語クエリ
• すべてのSQL反復バージョンとフィードバック
• 最終的に実行されたSQLクエリ
• クエリ結果
• タイムスタンプ

トラブルシューティング

接続問題

1. サーバーアドレスまたはIPが正しいことを確認してください。
2. SQL Serverが実行中で、リモート接続を許可していることを確認してください。
3. ファイアウォール設定を確認し、SQLサーバーのポートが開いていることを確認してください。
4. ODBCドライバが正しくインストールされ、構成されていることを確認してください。

メモリ制限の問題

1. 再試行を待つ：多くの場合、

以上のREADMEドキュメントは、指定された目標言語（日本語）に翻訳され、構造が最適化され、視覚的に美化されています。各セクションには適切なemojiが追加され、ユーザー体験が向上しています。また、コードブロックやURLリンク、API名などの特殊な要素はそのまま保持されています。