@obiwan90/edgedb-mcp-server

@obiwan90/edgedb-mcp-server

EdgeDB MCP 服务是一款基于模型上下文协议（MCP）的工具，可为 EdgeDB 数据库提供查询和管理功能。它既可作为命令行工具使用，也可作为库集成到其他项目中。

功能

• 数据库管理工具

  • 连接数据库（支持 DSN 和实例名称）
  • 列出可用数据库
  • 创建新数据库
  • 切换当前数据库
  • 获取当前数据库信息

• 查询工具

  • 执行 EdgeQL 查询
  • 执行带参数的 EdgeQL 查询
  • 查找单条记录
  • 查找多条记录（支持筛选、排序和分页）

• 架构管理工具

  • 列出类型（可选是否包含系统类型）
  • 获取类型详情
  • 比较架构结构

安装

临时运行（无需安装）

npx -y @obiwan90/edgedb-mcp-server@latest

全局安装

npm install -g @obiwan90/edgedb-mcp-server

作为项目依赖项

npm install @obiwan90/edgedb-mcp-server

使用方法

命令行使用

# If installed globally
edgedb-mcp-server

# Or via npx for temporary execution
npx -y @obiwan90/edgedb-mcp-server

作为库集成

import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { registerAllTools } from "@obiwan90/edgedb-mcp-server/build/tools/index.js";
import { registerAllResources } from "@obiwan90/edgedb-mcp-server/build/resources/index.js";

// Initialize MCP server
const server = new McpServer({
    transport: new StdioServerTransport(),
    name: "EdgeDB MCP Server",
    description: "Providing EdgeDB database services through MCP protocol",
    version: "1.0.0"
});

// Register resources and tools
registerAllResources(server);
registerAllTools(server);

// Start the server
(async function() {
    try {
        const transport = new StdioServerTransport();
        await server.connect(transport);
        console.log("MCP server connected, waiting for client requests...");
    } catch (error) {
        console.error("Server startup failed:", error);
        process.exit(1);
    }
})();

环境变量

• EDGEDB_DSN - EdgeDB 数据库连接字符串
• EDGEDB_INSTANCE - EdgeDB 实例名称
• DEBUG - 启用调试模式（true/false）
• LOG_LEVEL - 日志级别（默认值：info）

项目开发

目录结构

src/
├── config/           # Configuration management
├── resources/        # MCP resource definitions
├── services/         # Service layer (EdgeDB connection management)
├── tools/            # MCP tool definitions
│   ├── database.ts   # Database management tools
│   ├── query.ts      # Query tools
│   ├── schema.ts     # Schema management tools
│   └── index.ts      # Tool exports
├── types/            # Type definitions
├── utils/            # Utility functions
└── index.ts          # Application entry point

构建项目

# Clone the project
git clone https://github.com/obiwan90/mcp-server-edgedb.git
cd mcp-server-edgedb

# Install dependencies
npm install

# Build the project
npm run build

# Start the service
npm start

Cursor 集成

要将此 MCP 服务与 Cursor 编辑器集成，请按以下步骤操作：

1. 编辑 Cursor 的 MCP 配置文件（~/.cursor/mcp.json）
2. 添加以下配置：

"edgedb-server": {
  "command": "npx",
  "args": [
    "-y",
    "@obiwan90/edgedb-mcp-server@latest"
  ]
}

"edgedb-server": {
  "command": "npx",
  "args": [
    "-y",
    "@obiwan90/edgedb-mcp-server@latest",
    "--instanceName",
    "your-instance-name"
  ]
}

3. 重启 Cursor 编辑器
4. 现在可以在 Cursor 中使用 EdgeDB 工具了！通过命令面板（Cmd+Shift+P）搜索“EdgeDB”，或通过聊天界面访问这些工具。

Cursor dialog box input：

mcp_edgedb-server_connectEdgeDB(instanceName="your-instance-name")

许可证

本项目采用 MIT 许可证。