返回 MCP 目录
public公开dns本地运行

jiang-feishu-mcp

一个连接飞书文档的MCP服务,支持获取文档空间和列表,与AI客户端无缝集成。

article

README

🚀 飞书文档 MCP

飞书文档 MCP 是一个基于 Model Context Protocol (MCP) 的服务,它能让你在 Cursor 等 AI 客户端中直接访问飞书文档空间和文档列表,为使用 AI 处理飞书文档提供了便利。

🚀 快速开始

安装与运行

从源码安装

# 克隆项目
git clone https://github.com/yourusername/jiang-feishu-mcp.git
cd jiang-feishu-mcp

# 安装依赖
pnpm install

# 启动服务
pnpm start

服务器将在本地 7777 端口启动。

配置

在使用前,您需要创建一个 .env 文件配置飞书应用凭证:

# 复制示例配置文件
cp .env.example .env

然后编辑 .env 文件,填入您的飞书应用凭证:

FEISHU_APP_ID=your_app_id_here
FEISHU_APP_SECRET=your_app_secret_here

# 可选:设置端口号 (默认为7777)
PORT=7777

# 可选:设置文档保存路径 (默认为 ./docs)
DOCS_SAVE_PATH=./docs

获取飞书应用凭证的步骤:

  1. 访问 飞书开放平台 并登录
  2. 创建一个企业自建应用
  3. 在应用详情页获取 App ID 和 App Secret
  4. 确保开启了云文档相关权限(文档、表格、云空间读取权限)

在 Cursor 中使用

  1. 启动服务器:pnpm start
  2. 打开 Cursor 的设置页面
  3. 找到 "Model Context Protocol" 设置
  4. 添加新的 MCP Server,URL 填入:http://localhost:7777/mcp
  5. 保存设置

现在,您可以在 Cursor 中使用以下工具:

  • list-spaces:列出所有文档空间
  • list-documents:列出所有或指定空间的文档

✨ 主要特性

  • 支持获取飞书全部云文档空间列表
  • 支持获取指定空间的文档列表
  • 通过 MCP 协议与 AI 客户端无缝连接

📚 详细文档

什么是 MCP

MCP (Model Context Protocol) 是一个将自定义服务与各种 LLM 客户端(如 Claude、Cursor)无缝连接的协议。它允许 AI 直接调用和使用我们的服务功能。

  • MCP 客户端:AI 应用程序(如 Claude Desktop 或 Cursor),负责发起请求并与服务器通信
  • MCP 服务器:本项目,暴露飞书文档功能,通过标准化协议与客户端交互

💻 使用示例

基础用法

在 Cursor 中,您可以这样使用 MCP 工具:

请列出我所有的飞书文档空间
请列出空间 ID 为"XYZ123"中的所有文档

🔧 技术细节

该项目使用了以下技术:

  • Node.js 和 TypeScript:开发环境
  • MCP SDK:实现 MCP 服务器接口
  • Express:提供 HTTP 服务
  • 飞书开放 API:访问飞书文档内容

📄 许可证

MIT

⚠️ 重要提示

应用需要有访问飞书云文档的权限。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端