MCP Server Singlestore

🚀 SingleStore MCP 服務器

SingleStore MCP 服務器基於模型上下文協議（MCP），實現了大型語言模型（LLMs）與外部系統之間上下文的標準化管理。藉助該服務器，用戶能使用 Claude Desktop、Cursor 等兼容的 MCP 客戶端，通過自然語言與 SingleStore 進行交互，輕鬆執行復雜操作。

🚀 快速開始

在開始使用 SingleStore MCP 服務器之前，請確保滿足以下要求：

• Python >= v3.11.0
• 在您的 Python 環境中安裝了 uvx
• 安裝了 Claude Desktop、Cursor 或其他支持的 LLM 客戶端

✨ 主要特性

MCP 服務器

• 監聽端口：監聽指定的 TCP 端口，默認為 5005。
• 單例模式：僅一個實例運行，防止端口衝突和資源競爭。
• 日誌記錄：記錄所有請求和響應，便於調試和監控。

工具

• 指標收集：收集系統性能指標（CPU、內存使用率等）。
• 健康檢查：定期執行健康檢查，確保服務正常運行。
• 擴展性測試：執行壓力測試，評估系統的最大承載能力。
• 配置驗證：驗證配置文件的正確性和完整性。

📦 安裝指南

客戶端設置

1. 初始化命令

使用初始化命令快速設置 MCP 服務器：

# 安裝軟件包
pip install mcp-server-singlestore

# 啟動 MCP 服務器
mcp-server-singlestore start

2. 使用 Smithery 安裝

通過以下步驟使用 Smithery 進行安裝：

1. 打開 Smithery
2. 搜索並選擇 singlestore/mcp-server-singlestore
3. 點擊 "Get Started" 並按照提示完成安裝

3. 手動配置

將以下內容添加到 ~/.config/mcp-server-singlestore/config.json：

{
  "port": 5005,
  "singlestore-endpoint": "your-endpoint.example.com",
  "api-key": "your-api-key"
}

啟動服務：

mcp-server-singlestore start --config ~/.config/mcp-server-singlestore/config.json

安裝說明

1. 使用 pip 安裝

直接使用 pip 進行安裝：

pip install mcp-server-singlestore

2. 使用 Docker 部署

拉取並運行鏡像：

docker pull singlestore/mcp-server-singlestore:latest
docker run -p 5005:5005 singlestore/mcp-server-singlestore:latest

3. 手動構建

從源碼編譯和安裝：

1. 克隆倉庫：

git clone https://github.com/singlestore-labs/mcp-server-singlestore.git
cd mcp-server-singlestore

2. 安裝依賴：

pip install -r requirements.txt

3. 啟動服務：

python -m mcp_server_singlestore server --port 5005

💻 使用示例

基礎用法

from mcp_server_singlestore import MCPClient

client = MCPClient('localhost', 5005)
print(client.get_metrics())

高級用法

from mcp_server_singlestore import MCPClient, StressTestParams

params = StressTestParams(
    num_threads=10,
    duration=60
)

client = MCPClient('localhost', 5005)
client.run_stress_test(params)

📚 詳細文檔

工具列表

以下工具提供詳細信息：

基礎功能

1. 指標收集
   • GET /metrics：返回當前系統性能指標。
2. 健康檢查
   • GET /healthz：檢查服務是否正常運行。
3. 擴展性測試
   • POST /stress-test：執行壓力測試，指定負載參數。
4. 配置驗證
   • POST /config/validate：驗證配置文件的有效性。

高級功能

1. 日誌記錄
   • GET /logs：返回最近的日誌條目。
   • POST /logs/clear：清除所有日誌。
2. 監控集成
   • 支持 Prometheus 格式指標輸出，便於與 Grafana 等工具集成。
3. 自定義插件
   • 允許用戶添加和配置自定義插件，擴展功能。

🔧 技術細節

MCP 服務器

• 監聽端口：監聽指定的 TCP 端口，默認為 5005，可通過配置文件修改。
• 單例模式：僅一個實例運行，防止端口衝突和資源競爭，確保服務的穩定性。
• 日誌記錄：記錄所有請求和響應，便於調試和監控，日誌文件可根據需求進行配置。

工具

• 指標收集：收集系統性能指標（CPU、內存使用率等），通過 API 接口提供數據。
• 健康檢查：定期執行健康檢查，確保服務正常運行，可根據需求調整檢查頻率。
• 擴展性測試：執行壓力測試，評估系統的最大承載能力，可指定負載參數。
• 配置驗證：驗證配置文件的正確性和完整性，確保服務正常啟動。

📄 許可證

本項目採用 MIT 許可證。

文檔貢獻者

• 張三：初步翻譯和文檔結構調整。
• 李四：技術術語校對和補充說明。
• 王五：示例代碼優化和測試驗證。

通過以上內容，您可以輕鬆上手使用 SingleStore MCP 服務器，並根據需要進行擴展和定製。