🚀 使用指南
本指南详细介绍了如何安装、配置和使用相关项目，帮助你快速上手并解决可能遇到的问题。
🚀 快速开始
按照以下步骤，你可以快速完成项目的安装与启动：
- 克隆仓库。
- 执行
pnpm install安装依赖。 - 复制
.env.example为.env并填入飞书应用凭证。 - 使用
pnpm run dev启动服务器，可使用命令行参数。
📦 安装指南
安装依赖
克隆仓库后，在项目根目录下执行以下命令安装所需依赖：
pnpm install
配置环境变量
复制 .env.example 文件为 .env，并根据实际情况填入飞书应用凭证：
FEISHU_APP_ID：飞书应用 ID（必填）FEISHU_APP_SECRET：飞书应用密钥（必填）PORT：服务器运行端口，默认为 3333
启动服务器
使用以下命令启动服务器，可根据需要使用命令行参数：
pnpm run dev
📚 详细文档
配置指南
环境变量配置
| 属性 | 详情 |
|---|---|
FEISHU_APP_ID |
飞书应用 ID（必填） |
FEISHU_APP_SECRET |
飞书应用密钥（必填） |
PORT |
服务器运行端口，默认为 3333 |
命令行参数
| 参数 | 说明 |
|---|---|
--version |
显示版本号 |
--feishu-app-id |
指定飞书应用 ID |
--feishu-app-secret |
指定飞书应用密钥 |
--port |
指定服务器端口 |
--stdio |
以命令行模式运行服务器 |
--help |
显示帮助信息 |
连接配置
若要在 Cursor 中使用该服务，需进行如下连接配置：
- 打开 Cursor 设置。
- 进入
Settings > AI > MCP Servers。 - 添加新服务器，URL 设为
http://localhost:3333（或自定义端口）。 - 点击 "Verify Connection" 验证连接状态。
使用方法
在 Cursor 中使用该服务的具体步骤如下：
- 在 Cursor 中打开 AI 面板（默认快捷键：
Cmd+K或Ctrl+K）。 - 新建飞书文档时需指定
folderToken，例如访问文件夹链接如：https://vq5xxxxx7bc.feishu.cn/drive/folder/FPKvfjdxxxxx706RnOc查找。 - 修改文档内容时需提供具体的文档链接，例如：
https://vq5ixxxx7bc.feishu.cn/docx/J6T0d6exxxxxxxDdc1zqwnph。 - 提问或请求基于文档内容的操作。
权限配置与问题排查
权限类型
- 机器人权限
- 文档访问权限
权限验证与排查
- 获取 token：https://open.feishu.cn/api-explorer/cli_a75a8ca0ac79100c?apiName=tenant_access_token_internal&from=op_doc&project=auth&resource=auth&version=v3
- 使用 token 验证文档访问权限：https://open.feishu.cn/api-explorer/cli_a7582508c93ad16b?apiName=tenant_access_token_internal&from=op_doc&project=auth&resource=auth&version=v3
注意事项
⚠️ 重要提示
- 确保应用有足够权限。
- 文档链接需正确无误。
- 查看控制台输出日志。
附加信息
- 支持的命令行工具：pnpm、npm。
- 配置示例：
.env文件内容。 - 调试指南：如何排查问题。