返回市场
江飞书-mcp

江飞书-mcp

作者:upJiang23 星标更新:2025-04-03

项目介绍

飞书文档 MCP

这是一个用于连接飞书文档的模型上下文协议(MCP)服务,可以直接在AI客户端(如Cursor)中访问飞书文档空间和文档列表。

特性

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

什么是MCP

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

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

安装与运行

从源代码安装

# 克隆项目
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. 查找“模型上下文协议”设置
  4. 添加一个新的MCP服务器,填写URL:http://localhost:7777/mcp
  5. 保存设置

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

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

示例用法

在Cursor中,你可以按如下方式使用MCP工具:

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

技术架构

该项目使用了以下技术:

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

注意事项

  • 应用程序需要访问飞书云文档

许可证

MIT