MCP 服务器

CouchDB MCP Server

一个基于 TypeScript 的 MCP 服务器，它使 AI 助手能够通过一个简单的接口与 CouchDB 数据库进行交互，并提供创建、读取和查询数据库和文档的工具。

Tools

createDatabase

Create a new CouchDB database

listDatabases

List all CouchDB databases

deleteDatabase

Delete a CouchDB database

createDocument

Create a new document or update an existing document in a database

getDocument

Get a document from a database

createMangoIndex

Create a new Mango index (CouchDB 3.x+)

deleteMangoIndex

Delete a Mango index (CouchDB 3.x+)

listMangoIndexes

List all Mango indexes in a database (CouchDB 3.x+)

findDocuments

Query documents using Mango query (CouchDB 3.x+)

README

couchdb-mcp-server

一个用于与 CouchDB 交互的模型上下文协议服务器

这是一个基于 TypeScript 的 MCP 服务器，提供用于管理 CouchDB 数据库和文档的工具。它使 AI 助手能够通过一个简单的接口与 CouchDB 交互。

特性

工具

基础工具 (所有 CouchDB 版本)

createDatabase - 创建一个新的 CouchDB 数据库
- 接受 dbName 作为必需参数
- 如果数据库不存在，则创建它
listDatabases - 列出所有 CouchDB 数据库
- 返回一个数据库名称数组
deleteDatabase - 删除一个 CouchDB 数据库
- 接受 dbName 作为必需参数
- 移除指定的数据库及其所有文档
createDocument - 在数据库中创建一个新的文档或更新一个已存在的文档
- 必需参数:
  - dbName: 数据库名称
  - docId: 文档 ID
  - data: 文档数据 (JSON 对象)
    - 对于更新，包含带有当前文档修订版本的 _rev 字段
- 返回:
  - 对于新文档: 文档 ID 和新的修订版本
  - 对于更新: 文档 ID 和更新后的修订版本
- 基于 _rev 字段的存在自动检测操作是创建还是更新
getDocument - 从数据库中获取一个文档
- 必需参数:
  - dbName: 数据库名称
  - docId: 文档 ID
- 返回文档内容

Mango 查询工具 (仅 CouchDB 3.x+)

createMangoIndex - 创建一个新的 Mango 索引
- 必需参数:
  - dbName: 数据库名称
  - indexName: 索引名称
  - fields: 要索引的字段名称数组
- 创建一个新的索引以实现高效查询
deleteMangoIndex - 删除一个 Mango 索引
- 必需参数:
  - dbName: 数据库名称
  - designDoc: 设计文档名称
  - indexName: 索引名称
- 移除一个已存在的 Mango 索引
listMangoIndexes - 列出一个数据库中所有的 Mango 索引
- 必需参数:
  - dbName: 数据库名称
- 返回关于数据库中所有索引的信息
findDocuments - 使用 Mango 查询来查询文档
- 必需参数:
  - dbName: 数据库名称
  - query: Mango 查询对象
- 使用 CouchDB 的 Mango 查询语法执行查询

版本支持

服务器自动检测 CouchDB 版本并相应地启用功能：

所有版本：基本数据库和文档操作
CouchDB 3.x+：Mango 查询支持（索引和查询）

配置

服务器需要 CouchDB 连接 URL 和版本。这些可以通过环境变量提供：

COUCHDB_URL=http://username:password@localhost:5984
COUCHDB_VERSION=1.7.2

您可以在项目根目录中创建一个 `.env` 文件来进行配置。如果未提供，则默认为 `http://localhost:5984`。

## 开发

安装依赖:
```bash
npm install

构建服务器:

npm run build

用于自动重新构建的开发:

npm run watch

安装

通过 Smithery 安装

要通过 Smithery 为 Claude Desktop 自动安装 couchdb-mcp-server：

npx -y @smithery/cli install @robertoamoreno/couchdb-mcp-server --client claude

要与 Claude Desktop 一起使用，请添加服务器配置：

在 MacOS 上：~/Library/Application Support/Claude/claude_desktop_config.json 在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "couchdb-mcp-server": {
      "command": "/path/to/couchdb-mcp-server/build/index.js",
      "env": {
        "COUCHDB_URL": "http://username:password@localhost:5984"
      }
    }
  }
}