CouchDB MCP Server 使用说明

项目简介

CouchDB MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它充当AI助手（如 Claude）与 CouchDB 数据库之间的桥梁。通过提供一系列工具，该服务器允许 AI 助手以标准化的方式访问和操作 CouchDB 数据库，例如创建数据库、管理文档、执行 Mango 查询等。

主要功能点

数据库管理: 创建、列出和删除 CouchDB 数据库。
文档操作: 创建、获取和更新 CouchDB 文档。
Mango 查询 (CouchDB 3.x+): 支持 Mango 索引的创建、删除和列出，以及使用 Mango 查询语法查找文档。
版本兼容: 自动检测 CouchDB 版本，并根据版本启用相应的功能（基础功能支持所有版本，Mango 查询功能仅支持 3.x+ 版本）。
错误处理: 提供完善的错误处理机制，能够返回清晰的错误信息。

安装步骤

前提条件: 确保已安装 Node.js (14 或更高版本) 和运行中的 CouchDB 实例，并已配置 CouchDB 访问凭据（如果启用认证）。
下载代码: 从 GitHub 仓库 https://github.com/robertoamoreno/couchdb-mcp-server 克隆或下载代码。
安装依赖: 在项目根目录下，打开终端并运行 'npm install' 安装项目依赖。
构建项目: 运行 'npm run build' 构建项目，生成可执行的 JavaScript 文件。

服务器配置

要将 CouchDB MCP Server 集成到 MCP 客户端（例如 Claude Desktop），您需要配置客户端以连接到此服务器。以下是一个 'claude_desktop_config.json' 文件的配置示例，你需要根据你的实际环境进行调整：

{
  "mcpServers": {
    "couchdb-mcp-server": {
      "command": "/path/to/couchdb-mcp-server/build/index.js",  // CouchDB MCP Server 启动命令，请替换为实际的 index.js 文件路径
      "env": {
        "COUCHDB_URL": "http://username:password@localhost:5984" // CouchDB 连接 URL，请替换为你的 CouchDB 服务器地址和认证信息
        // "COUCHDB_VERSION": "3.2.0" // (可选) CouchDB 版本，如果未设置，服务器会自动检测
      }
    }
  }
}

配置参数说明:

'"couchdb-mcp-server"': 服务器名称，在客户端配置中用于标识该服务器。
'"command"': 必须配置。指向 CouchDB MCP Server 构建后的 'index.js' 文件的绝对路径。请根据你的实际文件路径进行修改。
'"env"': 必须配置。环境变量配置，用于传递 CouchDB 连接信息给服务器。
- '"COUCHDB_URL"': 必须配置。 CouchDB 服务器的 URL，包括协议、用户名、密码、主机和端口。例如 'http://admin:password@localhost:5984'。
- '"COUCHDB_VERSION"': 可选配置。显式指定 CouchDB 版本。如果未提供，服务器将尝试自动检测。建议在自动检测不准确时手动设置。

MCP客户端配置路径:

MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%/Claude/claude_desktop_config.json'

基本使用方法

启动服务器: MCP 服务器会在客户端（如 Claude）连接时自动启动。无需手动运行 'index.js' 文件，客户端会根据配置文件中的 'command' 指令启动服务器进程。
通过 AI 助手调用工具: 在支持 MCP 的 AI 助手 (如 Claude) 中，你可以通过自然语言指令来调用 CouchDB MCP Server 提供的工具。例如：
- "列出所有数据库" (对应 'listDatabases' 工具)
- "创建一个名为 'mydatabase' 的数据库" (对应 'createDatabase' 工具)
- "在 'mydatabase' 数据库中创建一个文档，ID 为 'mydoc'，内容为 '{"name": "example", "value": 123}'" (对应 'createDocument' 工具)

AI 助手会解析你的指令，并根据工具的定义和参数，自动调用 CouchDB MCP Server 提供的相应功能，并将结果返回给你。

调试: 如果遇到问题，可以使用 'npm run inspector' 命令运行 MCP Inspector 进行调试，具体参考仓库 README 文档。

关键词