星战科技xingzhan.cloud
返回市场
mcp-webdav服务器

mcp-webdav服务器

作者：LaubPlusCo11 星标更新：2025-03-20
安装使用来源：spider==github.com

项目介绍

WebDAV MCP 服务器

这是一个基于模型上下文协议（MCP）的服务器，它支持在具有基本身份验证的WebDAV端点上执行CRUD操作。此服务器使Claude Desktop和其他MCP客户端能够通过自然语言命令与WebDAV文件系统进行交互。

功能

  • 连接到任何WebDAV服务器，并可选地使用身份验证
  • 对文件和目录执行CRUD操作
  • 将文件操作暴露为MCP资源和工具
  • 通过stdio传输（用于Claude Desktop集成）或HTTP/SSE传输运行
  • 使用可选的基本身份验证进行安全访问
  • 支持使用bcrypt加密密码进行MCP服务器的身份验证（由于协议限制，WebDAV密码必须是明文）
  • 与WebDAV服务器连接池以提高性能
  • 使用Zod进行配置验证
  • 结构化日志记录以更好地进行故障排除

预备条件

  • Node.js 18或更高版本
  • npm 或 yarn
  • WebDAV服务器（用于实际文件操作）

安装

方案1：从npm包安装

# 全局安装
npm install -g webdav-mcp-server

# 或者使用npx
npx webdav-mcp-server

方案2：克隆并从源代码构建

# 克隆仓库
git clone https://github.com/yourusername/webdav-mcp-server.git
cd webdav-mcp-server

# 安装依赖
npm install

# 构建应用程序
npm run build

方案3：Docker

# 构建Docker镜像
docker build -t webdav-mcp-server .

# 在没有认证的情况下运行容器
docker run -p 3000:3000 \
  -e WEBDAV_ROOT_URL=http://your-webdav-server \
  -e WEBDAV_ROOT_PATH=/webdav \
  webdav-mcp-server
  
# 在WebDAV和MCP服务器都启用认证的情况下运行容器
docker run -p 3000:3000 \
  -e WEBDAV_ROOT_URL=http://your-webdav-server \
  -e WEBDAV_ROOT_PATH=/webdav \
  -e WEBDAV_AUTH_ENABLED=true \
  -e WEBDAV_USERNAME=admin \
  -e WEBDAV_PASSWORD=password \
  -e AUTH_ENABLED=true \
  -e AUTH_USERNAME=user \
  -e AUTH_PASSWORD=pass \
  webdav-mcp-server

配置

在根目录创建一个.env文件，包含以下变量：

# WebDAV配置
WEBDAV_ROOT_URL=http://localhost:4080
WEBDAV_ROOT_PATH=/webdav

# WebDAV认证（可选）
WEBDAV_AUTH_ENABLED=true
WEBDAV_USERNAME=admin

# WebDAV密码必须是明文（当启用认证时需要）
# WebDAV协议要求将实际密码发送到服务器
WEBDAV_PASSWORD=password

# 服务器配置（适用于HTTP模式）
SERVER_PORT=3000

# MCP服务器认证配置（可选）
AUTH_ENABLED=true
AUTH_USERNAME=user
AUTH_PASSWORD=pass
AUTH_REALM=MCP WebDAV Server

# MCP服务器认证密码可以是bcrypt哈希（不同于WebDAV密码）
# AUTH_PASSWORD={bcrypt}$2y$10$CyLKnUwn9fqqKQFEbxpZFuE9mzWR/x8t6TE7.CgAN0oT8I/5jKJBy

加密密码用于MCP服务器认证

为了增强MCP服务器的安全性（而不是WebDAV连接），您可以使用bcrypt加密密码而不是存储明文密码：

  1. 生成bcrypt哈希：

    # 使用内置工具
npm run generate-hash -- yourpassword

# 或者使用npx
npx webdav-mcp-generate-hash yourpassword

  2. 将哈希添加到您的.env文件中，前面加上{bcrypt}前缀：

    AUTH_PASSWORD={bcrypt}$2y$10$CyLKnUwn9fqqKQFEbxpZFuE9mzWR/x8t6TE7.CgAN0oT8I/5jKJBy

这样，您的MCP服务器密码就得到了安全存储。请注意，由于协议要求，WebDAV密码必须始终是明文。

使用方法

使用stdio传输运行

此模式适合直接与Claude Desktop集成。

# 如果全局安装
webdav-mcp-server

# 如果使用npx
npx webdav-mcp-server

# 如果从源代码构建
node dist/index.js

使用HTTP/SSE传输运行

此模式允许服务器通过HTTP和服务器发送事件（SSE）进行实时通信。

# 如果全局安装
webdav-mcp-server --http

# 如果使用npx
npx webdav-mcp-server --http

# 如果从源代码构建
node dist/index.js --http

使用Docker Compose快速开始

最简单的方法是同时启动WebDAV服务器和MCP服务器，使用Docker Compose：

# 启动WebDAV和MCP服务器
cd docker
docker-compose up -d

# 这将启动：
# - hacdias/webdav服务器，端口4080（用户名：admin，密码：admin）
# - MCP服务器，端口3000（用户名：user，密码：pass）

此设置使用hacdias/webdav，这是一个用Go编写的简单独立的WebDAV服务器。WebDAV服务器的配置存储在webdav_config.yml中，您可以修改它来调整权限、添加用户或更改其他设置。

WebDAV服务器将所有文件存储在一个名为webdav_data的Docker卷中，该卷在容器重启后仍然存在。

WebDAV服务器配置

webdav_config.yml文件配置了在Docker Compose设置中使用的hacdias/webdav服务器。以下是您可以自定义的内容：

# 服务器地址和端口
address: 0.0.0.0
port: 6060

# 根数据目录
directory: /data

# 开启/关闭CORS
cors:
  enabled: true
  # 更多CORS设置...

# 默认权限（C=创建，R=读取，U=更新，D=删除）
permissions: CRUD

# 用户定义
users:
  - username: admin
    password: admin      # 明文密码
    permissions: CRUD    # 完全权限
  
  - username: reader
    password: reader
    permissions: R       # 只读权限
    
  # 您也可以使用bcrypt加密密码
  - username: secure
    password: "{bcrypt}$2y$10$zEP6oofmXFeHaeMfBNLnP.DO8m.H.Mwhd24/TOX2MWLxAExXi4qgi"

有关更高级的配置选项，请参阅hacdias/webdav文档。

测试

要运行测试：

npm test

与Claude Desktop集成

  1. 确保在Claude Desktop中启用了MCP功能
<details> <summary>使用npx</summary> 2. 打开Claude Desktop设置并点击编辑配置（`claude_desktop_config.json`） 3. 添加 ```json { "mcpServers": { "webdav": { "command": "npx", "args": [ "-y", "webdav-mcp-server" ], "env": { "WEBDAV_ROOT_URL": "<WEBDAV_ROOT_URL>", "WEBDAV_ROOT_PATH": "<WEBDAV_ROOT_PATH>", "WEBDAV_USERNAME": "<WEBDAV_USERNAME>", "WEBDAV_PASSWORD": "<WEBDAV_PASSWORD>", "WEBDAV_AUTH_ENABLED": "true|false" } } } } ``` </details> <details> <summary>使用node和本地构建</summary> 2. 克隆此仓库并运行mac/linux上的`setup.sh`或Windows上的`setup.bat` 3. 打开Claude Desktop设置并点击编辑配置（`claude_desktop_config.json`） 4. 添加 ```json { "mcpServers": { "webdav": { "command": "node", "args": [ "<仓库路径>/dist/index.js" ], "env": { "WEBDAV_ROOT_URL": "<WEBDAV_ROOT_URL>", "WEBDAV_ROOT_PATH": "<WEBDAV_ROOT_PATH>", "WEBDAV_USERNAME": "<WEBDAV_USERNAME>", "WEBDAV_PASSWORD": "<WEBDAV_PASSWORD>", "WEBDAV_AUTH_ENABLED": "true|false" } } } } ``` </details>

可用的MCP资源

  • webdav://{path}/list - 列出目录中的文件
  • webdav://{path}/content - 获取文件内容
  • webdav://{path}/info - 获取文件或目录信息

可用的MCP工具

  • webdav_create_remote_file - 在远程WebDAV服务器上创建新文件
  • webdav_get_remote_file - 从远程WebDAV服务器获取文件内容
  • webdav_update_remote_file - 更新远程WebDAV服务器上的现有文件
  • webdav_delete_remote_item - 从远程WebDAV服务器删除文件或目录
  • webdav_create_remote_directory - 在远程WebDAV服务器上创建新目录
  • webdav_move_remote_item - 移动或重命名远程WebDAV服务器上的文件/目录
  • webdav_copy_remote_item - 复制远程WebDAV服务器上的文件/目录到新位置
  • webdav_list_remote_directory - 列出远程WebDAV服务器上的文件和目录

可用的MCP提示

  • webdav_create_remote_file - 提示在远程WebDAV服务器上创建新文件
  • webdav_get_remote_file - 提示从远程WebDAV文件获取内容
  • webdav_update_remote_file - 提示更新远程WebDAV服务器上的文件
  • webdav_delete_remote_item - 提示从远程WebDAV服务器删除文件/目录
  • webdav_list_remote_directory - 提示列出远程WebDAV服务器上的目录内容
  • webdav_create_remote_directory - 提示在远程WebDAV服务器上创建目录
  • webdav_move_remote_item - 提示移动/重命名远程WebDAV服务器上的文件/目录
  • webdav_copy_remote_item - 提示复制远程WebDAV服务器上的文件/目录

在Claude中的示例查询

一旦WebDAV MCP服务器连接到Claude Desktop，您可以使用以下示例查询：

  • "列出我远程WebDAV服务器上的文件"
  • "在我的远程WebDAV服务器上创建一个名为notes.txt的新文本文件，内容如下：Hello World"
  • "从我的远程WebDAV服务器获取document.txt的内容"
  • "使用这个新的配置更新我的远程WebDAV服务器上的config.json"
  • "在我的远程WebDAV服务器上创建一个名为projects的目录"
  • "将report.docx复制到我的远程WebDAV服务器上的备份位置"
  • "将文件old_name.txt重命名为new_name.txt在我的远程WebDAV服务器上"
  • "从我的远程WebDAV服务器删除temp.txt"

程序化使用

您还可以在自己的项目中程序化地使用此包：

import { startWebDAVServer } from 'webdav-mcp-server';

// 对于无认证的stdio传输
await startWebDAVServer({
  webdavConfig: {
    rootUrl: 'http://your-webdav-server',
    rootPath: '/webdav',
    authEnabled: false
  },
  useHttp: false
});

// 对于带WebDAV认证的stdio传输（密码必须是明文）
await startWebDAVServer({
  webdavConfig: {
    rootUrl: 'http://your-webdav-server',
    rootPath: '/webdav',
    authEnabled: true,
    username: 'admin',
    password: 'password'
  },
  useHttp: false
});

// 使用bcrypt哈希作为MCP服务器密码（仅限HTTP认证）
await startWebDAVServer({
  webdavConfig: {
    rootUrl: 'http://your-webdav-server',
    rootPath: '/webdav',
    authEnabled: true,
    username: 'admin',
    password: 'password' // WebDAV密码必须是明文
  },
  useHttp: true,
  httpConfig: {
    port: 3000,
    auth: {
      enabled: true,
      username: 'user',
      password: '{bcrypt}$2y$10$CyLKnUwn9fqqKQFEbxpZFuE9mzWR/x8t6TE7.CgAN0oT8I/5jKJBy'
    }
  }
});

// 对于带MCP认证的HTTP传输
await startWebDAVServer({
  webdavConfig: {
    rootUrl: 'http://your-webdav-server',
    rootPath: '/webdav',
    authEnabled: true,
    username: 'admin',
    password: 'password'
  },
  useHttp: true,
  httpConfig: {
    port: 3000,
    auth: {
      enabled: true,
      username: 'user',
      password: 'pass',
      realm: 'MCP WebDAV Server'
    }
  }
});

// 对于无认证的HTTP传输
await startWebDAVServer({
  webdavConfig: {
    rootUrl: 'http://your-webdav-server',
    rootPath: '/webdav',
    authEnabled: false
  },
  useHttp: true,
  httpConfig: {
    port: 3000,
    auth: {
      enabled: false
    }
  }
});

许可证

MIT