@dasaying/feishu-doc-mcp 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +328 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +15009 -0
- package/dist/index.js.map +1 -0
- package/package.json +175 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2025 Casey Hand @cyanheads
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,328 @@
|
|
|
1
|
+
# @dasaying/feishu-doc-mcp
|
|
2
|
+
|
|
3
|
+
<div align="center">
|
|
4
|
+
|
|
5
|
+
**飞书云文档 MCP 服务器 - 支持 Markdown 文档上传、读取和批量操作**
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/@dasaying/feishu-doc-mcp)
|
|
8
|
+
[](./LICENSE)
|
|
9
|
+
[](https://modelcontextprotocol.io/)
|
|
10
|
+
|
|
11
|
+
[English](#english) | [中文](#中文)
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 中文
|
|
18
|
+
|
|
19
|
+
### 简介
|
|
20
|
+
|
|
21
|
+
feishu-doc-mcp 是一个功能完整的 Model Context Protocol (MCP) 服务器，专门用于飞书（Lark）云文档集成。它提供了强大的 Markdown 文档上传、读取和批量操作功能，让你可以轻松地在 AI 工作流中管理飞书文档。
|
|
22
|
+
|
|
23
|
+
### 核心功能
|
|
24
|
+
|
|
25
|
+
#### 📤 文档上传
|
|
26
|
+
- ✅ 单个 Markdown 文档上传
|
|
27
|
+
- ✅ 批量文档上传（支持并发控制）
|
|
28
|
+
- ✅ 自动转换 Markdown 为飞书格式
|
|
29
|
+
- ✅ 自动上传本地图片和附件
|
|
30
|
+
- ✅ Front Matter 处理
|
|
31
|
+
- ✅ 支持云空间和知识库
|
|
32
|
+
|
|
33
|
+
#### 📥 文档读取
|
|
34
|
+
- ✅ 读取单个文档并转换为 Markdown
|
|
35
|
+
- ✅ 批量读取多个文档
|
|
36
|
+
- ✅ 递归读取整个知识库
|
|
37
|
+
- ✅ 自动下载图片和附件
|
|
38
|
+
- ✅ 保持文档结构和格式
|
|
39
|
+
|
|
40
|
+
#### 🔐 认证管理
|
|
41
|
+
- ✅ 完整的 OAuth 2.0 流程
|
|
42
|
+
- ✅ 自动 token 刷新
|
|
43
|
+
- ✅ 多应用支持
|
|
44
|
+
- ✅ 安全的凭证存储
|
|
45
|
+
|
|
46
|
+
#### 📁 资源管理
|
|
47
|
+
- ✅ 列出云空间文件夹
|
|
48
|
+
- ✅ 列出知识库空间
|
|
49
|
+
- ✅ 浏览知识库节点
|
|
50
|
+
- ✅ 获取用户信息
|
|
51
|
+
|
|
52
|
+
### 快速开始
|
|
53
|
+
|
|
54
|
+
#### 使用 npx（推荐）
|
|
55
|
+
|
|
56
|
+
无需安装，直接使用：
|
|
57
|
+
|
|
58
|
+
```json
|
|
59
|
+
{
|
|
60
|
+
"mcpServers": {
|
|
61
|
+
"@dasaying/feishu-doc-mcp": {
|
|
62
|
+
"command": "npx",
|
|
63
|
+
"args": ["-y", "@dasaying/feishu-doc-mcp"],
|
|
64
|
+
"env": {
|
|
65
|
+
"FEISHU_DEFAULT_APP_ID": "your_app_id",
|
|
66
|
+
"FEISHU_DEFAULT_APP_SECRET": "your_app_secret",
|
|
67
|
+
"FEISHU_OAUTH_CALLBACK_URL": "http://localhost:3010/oauth/feishu/callback"
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
#### 全局安装
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
npm install -g @dasaying/feishu-doc-mcp
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
配置 MCP 客户端：
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"mcpServers": {
|
|
85
|
+
"@dasaying/feishu-doc-mcp": {
|
|
86
|
+
"command": "@dasaying/feishu-doc-mcp",
|
|
87
|
+
"args": [],
|
|
88
|
+
"env": {
|
|
89
|
+
"FEISHU_DEFAULT_APP_ID": "your_app_id",
|
|
90
|
+
"FEISHU_DEFAULT_APP_SECRET": "your_app_secret",
|
|
91
|
+
"FEISHU_OAUTH_CALLBACK_URL": "http://localhost:3010/oauth/feishu/callback"
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### 配置说明
|
|
99
|
+
|
|
100
|
+
#### 必需环境变量
|
|
101
|
+
|
|
102
|
+
| 变量 | 说明 | 示例 |
|
|
103
|
+
|------|------|------|
|
|
104
|
+
| `FEISHU_DEFAULT_APP_ID` | 飞书应用 ID | `cli_a9e211f948381bdf` |
|
|
105
|
+
| `FEISHU_DEFAULT_APP_SECRET` | 飞书应用密钥 | `your_app_secret` |
|
|
106
|
+
| `FEISHU_OAUTH_CALLBACK_URL` | OAuth 回调地址 | `http://localhost:3010/oauth/feishu/callback` |
|
|
107
|
+
|
|
108
|
+
#### 可选环境变量
|
|
109
|
+
|
|
110
|
+
| 变量 | 说明 | 默认值 |
|
|
111
|
+
|------|------|--------|
|
|
112
|
+
| `MCP_LOG_LEVEL` | 日志级别 | `debug` |
|
|
113
|
+
| `STORAGE_PROVIDER_TYPE` | 存储类型 | `filesystem` |
|
|
114
|
+
| `STORAGE_FILESYSTEM_PATH` | 存储路径 | `~/.feishu-doc-mcp/storage` |
|
|
115
|
+
|
|
116
|
+
### 可用工具
|
|
117
|
+
|
|
118
|
+
#### 认证相关
|
|
119
|
+
- `feishu_auth_url` - 生成授权 URL
|
|
120
|
+
- `feishu_auth_callback` - 处理授权回调
|
|
121
|
+
- `feishu_get_user_info` - 获取用户信息
|
|
122
|
+
- `feishu_list_apps` - 列出已配置的应用
|
|
123
|
+
- `feishu_set_default_app` - 设置默认应用
|
|
124
|
+
|
|
125
|
+
#### 文档上传
|
|
126
|
+
- `feishu_upload_markdown` - 上传单个 Markdown 文档
|
|
127
|
+
- `feishu_batch_upload_markdown` - 批量上传文档
|
|
128
|
+
- `feishu_update_document` - 更新已存在的文档
|
|
129
|
+
|
|
130
|
+
#### 文档读取
|
|
131
|
+
- `feishu_read_document` - 读取单个文档
|
|
132
|
+
- `feishu_batch_read_documents` - 批量读取文档
|
|
133
|
+
- `feishu_read_wiki_recursive` - 递归读取知识库
|
|
134
|
+
|
|
135
|
+
#### 资源浏览
|
|
136
|
+
- `feishu_list_folders` - 列出云空间文件夹
|
|
137
|
+
- `feishu_list_wikis` - 列出知识库空间
|
|
138
|
+
- `feishu_list_wiki_nodes` - 列出知识库节点
|
|
139
|
+
|
|
140
|
+
### 使用示例
|
|
141
|
+
|
|
142
|
+
#### 1. 授权飞书账号
|
|
143
|
+
|
|
144
|
+
```typescript
|
|
145
|
+
// 生成授权 URL
|
|
146
|
+
const { authUrl } = await mcp.call('feishu_auth_url');
|
|
147
|
+
// 在浏览器中打开 authUrl 完成授权
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
#### 2. 上传 Markdown 文档
|
|
151
|
+
|
|
152
|
+
```typescript
|
|
153
|
+
// 上传到知识库
|
|
154
|
+
await mcp.call('feishu_upload_markdown', {
|
|
155
|
+
filePath: './docs/README.md',
|
|
156
|
+
targetType: 'wiki',
|
|
157
|
+
targetId: 'wiki_space_id',
|
|
158
|
+
uploadImages: true,
|
|
159
|
+
uploadAttachments: true
|
|
160
|
+
});
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
#### 3. 读取文档
|
|
164
|
+
|
|
165
|
+
```typescript
|
|
166
|
+
// 读取文档并保存为 Markdown
|
|
167
|
+
await mcp.call('feishu_read_document', {
|
|
168
|
+
documentId: 'doc_id',
|
|
169
|
+
documentType: 'wiki',
|
|
170
|
+
wikiSpaceId: 'space_id',
|
|
171
|
+
outputPath: './output/document.md',
|
|
172
|
+
downloadImages: true
|
|
173
|
+
});
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
#### 4. 批量操作
|
|
177
|
+
|
|
178
|
+
```typescript
|
|
179
|
+
// 批量上传
|
|
180
|
+
await mcp.call('feishu_batch_upload_markdown', {
|
|
181
|
+
documents: [
|
|
182
|
+
{ filePath: './doc1.md', targetType: 'wiki', targetId: 'space_id' },
|
|
183
|
+
{ filePath: './doc2.md', targetType: 'wiki', targetId: 'space_id' }
|
|
184
|
+
],
|
|
185
|
+
concurrency: 3
|
|
186
|
+
});
|
|
187
|
+
|
|
188
|
+
// 递归读取知识库
|
|
189
|
+
await mcp.call('feishu_read_wiki_recursive', {
|
|
190
|
+
wikiSpaceId: 'space_id',
|
|
191
|
+
outputPath: './output',
|
|
192
|
+
downloadImages: true,
|
|
193
|
+
preserveStructure: true
|
|
194
|
+
});
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### 飞书应用配置
|
|
198
|
+
|
|
199
|
+
1. 访问 [飞书开放平台](https://open.feishu.cn/)
|
|
200
|
+
2. 创建企业自建应用
|
|
201
|
+
3. 配置应用权限：
|
|
202
|
+
- `drive:drive` - 云空间操作
|
|
203
|
+
- `wiki:wiki` - 知识库操作
|
|
204
|
+
- `contact:user.base` - 用户信息
|
|
205
|
+
4. 配置 OAuth 回调地址：`http://localhost:3010/oauth/feishu/callback`
|
|
206
|
+
5. 获取 App ID 和 App Secret
|
|
207
|
+
|
|
208
|
+
### 开发
|
|
209
|
+
|
|
210
|
+
```bash
|
|
211
|
+
# 克隆仓库
|
|
212
|
+
git clone https://github.com/yourusername/feishu-doc-mcp.git
|
|
213
|
+
cd feishu-doc-mcp
|
|
214
|
+
|
|
215
|
+
# 安装依赖
|
|
216
|
+
npm install
|
|
217
|
+
|
|
218
|
+
# 构建
|
|
219
|
+
npm run build
|
|
220
|
+
|
|
221
|
+
# 本地测试
|
|
222
|
+
npm link
|
|
223
|
+
feishu-doc-mcp
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### 技术栈
|
|
227
|
+
|
|
228
|
+
- **TypeScript** - 类型安全
|
|
229
|
+
- **MCP SDK** - Model Context Protocol
|
|
230
|
+
- **Hono** - 轻量级 Web 框架
|
|
231
|
+
- **tsyringe** - 依赖注入
|
|
232
|
+
- **Zod** - 运行时验证
|
|
233
|
+
- **Pino** - 结构化日志
|
|
234
|
+
|
|
235
|
+
### 许可证
|
|
236
|
+
|
|
237
|
+
Apache-2.0
|
|
238
|
+
|
|
239
|
+
---
|
|
240
|
+
|
|
241
|
+
## English
|
|
242
|
+
|
|
243
|
+
### Introduction
|
|
244
|
+
|
|
245
|
+
feishu-doc-mcp is a full-featured Model Context Protocol (MCP) server specifically designed for Feishu (Lark) document integration. It provides powerful Markdown document upload, read, and batch operation capabilities, making it easy to manage Feishu documents in AI workflows.
|
|
246
|
+
|
|
247
|
+
### Core Features
|
|
248
|
+
|
|
249
|
+
#### 📤 Document Upload
|
|
250
|
+
- ✅ Single Markdown document upload
|
|
251
|
+
- ✅ Batch document upload (with concurrency control)
|
|
252
|
+
- ✅ Automatic Markdown to Feishu format conversion
|
|
253
|
+
- ✅ Automatic local image and attachment upload
|
|
254
|
+
- ✅ Front Matter processing
|
|
255
|
+
- ✅ Support for Drive and Wiki
|
|
256
|
+
|
|
257
|
+
#### 📥 Document Read
|
|
258
|
+
- ✅ Read single document and convert to Markdown
|
|
259
|
+
- ✅ Batch read multiple documents
|
|
260
|
+
- ✅ Recursively read entire wiki space
|
|
261
|
+
- ✅ Automatic image and attachment download
|
|
262
|
+
- ✅ Preserve document structure and formatting
|
|
263
|
+
|
|
264
|
+
#### 🔐 Authentication
|
|
265
|
+
- ✅ Complete OAuth 2.0 flow
|
|
266
|
+
- ✅ Automatic token refresh
|
|
267
|
+
- ✅ Multi-app support
|
|
268
|
+
- ✅ Secure credential storage
|
|
269
|
+
|
|
270
|
+
#### 📁 Resource Management
|
|
271
|
+
- ✅ List Drive folders
|
|
272
|
+
- ✅ List Wiki spaces
|
|
273
|
+
- ✅ Browse Wiki nodes
|
|
274
|
+
- ✅ Get user information
|
|
275
|
+
|
|
276
|
+
### Quick Start
|
|
277
|
+
|
|
278
|
+
#### Using npx (Recommended)
|
|
279
|
+
|
|
280
|
+
No installation required:
|
|
281
|
+
|
|
282
|
+
```json
|
|
283
|
+
{
|
|
284
|
+
"mcpServers": {
|
|
285
|
+
"@dasaying/feishu-doc-mcp": {
|
|
286
|
+
"command": "npx",
|
|
287
|
+
"args": ["-y", "@dasaying/feishu-doc-mcp"],
|
|
288
|
+
"env": {
|
|
289
|
+
"FEISHU_DEFAULT_APP_ID": "your_app_id",
|
|
290
|
+
"FEISHU_DEFAULT_APP_SECRET": "your_app_secret",
|
|
291
|
+
"FEISHU_OAUTH_CALLBACK_URL": "http://localhost:3010/oauth/feishu/callback"
|
|
292
|
+
}
|
|
293
|
+
}
|
|
294
|
+
}
|
|
295
|
+
}
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
#### Global Installation
|
|
299
|
+
|
|
300
|
+
```bash
|
|
301
|
+
npm install -g @dasaying/feishu-doc-mcp
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
Configure MCP client:
|
|
305
|
+
|
|
306
|
+
```json
|
|
307
|
+
{
|
|
308
|
+
"mcpServers": {
|
|
309
|
+
"@dasaying/feishu-doc-mcp": {
|
|
310
|
+
"command": "@dasaying/feishu-doc-mcp",
|
|
311
|
+
"args": [],
|
|
312
|
+
"env": {
|
|
313
|
+
"FEISHU_DEFAULT_APP_ID": "your_app_id",
|
|
314
|
+
"FEISHU_DEFAULT_APP_SECRET": "your_app_secret",
|
|
315
|
+
"FEISHU_OAUTH_CALLBACK_URL": "http://localhost:3010/oauth/feishu/callback"
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
}
|
|
319
|
+
}
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
### Available Tools
|
|
323
|
+
|
|
324
|
+
See Chinese section above for detailed tool list.
|
|
325
|
+
|
|
326
|
+
### License
|
|
327
|
+
|
|
328
|
+
Apache-2.0
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|