Singlestore MCP Server

🚀 單店數據庫MCP協議服務器

這是一個專為SingleStore數據庫設計的單進程MCP（Multi-Protocol Communications Protocol）協議服務器。它支持通過標準MCP協議或基於HTTP的Server-Sent Events (SSE) 進行通信，能滿足多種數據交互需求。

🚀 快速開始

本服務器使用Node.js進行安裝，以下是啟動服務器的基本步驟：

# 安裝依賴
npm install mcp-server-singlestore

# 啟動服務器（假設環境變量已配置）
node src/index.ts

✨ 主要特性

• 數據庫連接：支持通過MCP協議或HTTP與SingleStore數據庫建立連接。
• 查詢執行：能夠執行SQL查詢並返回結果。
• SSE支持：提供基於HTTP的流數據傳輸功能，適用於即時數據推送場景。

📦 安裝指南

安裝依賴

使用Node.js進行安裝：

npm install mcp-server-singlestore

啟動服務器

node src/index.ts

💻 使用示例

基本用法

# 安裝依賴
npm install mcp-server-singlestore

# 啟動服務器（假設環境變量已配置）
node src/index.ts

配置文件示例

const config = {
  singleStoreHost: 'localhost',
  singleStorePort: 3307,
  singleStoreUser: 'admin',
  singleStorePassword: 'password',
  // 可選配置
  sslCaBundle: '/path/to/ca.pem',
  mcpServerPort: 4000,
  sseEnabled: true,
  ssePort: 4001
};

require('mcp-server-singlestore').start(config);

在Claude中使用

function useMCPTool(commands) {
  return {
    connectDatabase(options) {
      // 實現數據庫連接邏輯
    },
    executeQuery(query, params) {
      // 執行查詢並返回結果
    }
  };
}

export default useMCPTool;

在Windsurf中配置

const config = {
  type: 'singlestore',
  host: 'localhost',
  port: 3307,
  user: 'admin',
  password: 'password'
};

// 初始化數據庫連接
const db = new Database(config);

在Cursor中使用

const { Cursor } = require('cursor');

const cursor = new Cursor({
  databaseConfig: {
    type: 'singlestore',
    host: 'localhost',
    port: 3307,
    user: 'admin',
    password: 'password'
  }
});

// 查詢示例
cursor.query('SELECT * FROM users LIMIT 10', (err, result) => {
  if (err) throw err;
  console.log(result);
});

📚 詳細文檔

配置

運行時所需的環境變量如下：

集成

本服務器可集成到Claude、Windsurf和Cursor等工具中，具體使用方法見使用示例部分。

安全注意事項

⚠️ 重要提示

• 絕不要將憑證提交到版本控制系統中。
• 在生產環境中，建議將數據庫和應用服務置於受控的網絡內部。
• 嚴格限制數據庫連接用戶的權限。

項目結構

src/
├── index.ts                 # 入口文件
├── server.ts                # MCP服務器實現
└── sseServer.ts             # SSE服務器實現

開發

安裝依賴

npm install express mysql2

啟動開發環境

npm run dev

故障排除

連接問題

• 檢查目標數據庫是否運行。
• 確認網絡連接正常。
• 驗證提供的憑證是否正確。

查詢問題

• 確保查詢語法正確無誤。
• 檢查是否有權限訪問相關數據表和列。

貢獻指南

如發現任何問題，請通過GitHub提交Issue或Pull Request。

📄 許可證

項目採用MIT許可證，具體條款參見LICENSE文件。