feishu-doc-mcp 1.0.0 → 1.0.1

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.
Files changed (2) hide show
  1. package/README.md +38 -39
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,42 +1,42 @@
1
1
  # Feishu Doc MCP
2
2
 
3
- A Model Context Protocol (MCP) server for accessing Feishu (Lark) Open Platform documentation. This server enables AI assistants like Claude to search and read Feishu API documentation directly.
3
+ 一个用于访问飞书开放平台文档的 Model Context Protocol (MCP) 服务器。该服务器使 Claude 等 AI 助手能够直接搜索和阅读飞书 API 文档。
4
4
 
5
- ## Features
5
+ ## 功能特性
6
6
 
7
- - Search Feishu API documentation by category
8
- - Read detailed documentation content
9
- - Support for multiple API categories including:
10
- - Server API (Messaging, Calendar, Contacts, etc.)
11
- - Client API (Web apps, Mini programs, etc.)
12
- - Development Guides (Bots, Web apps, etc.)
13
- - And many more...
7
+ - 按分类搜索飞书 API 文档
8
+ - 读取详细的文档内容
9
+ - 支持多种 API 分类：
10
+ - 服务端 API（消息、日历、通讯录等）
11
+ - 客户端 API（网页应用、小程序等）
12
+ - 开发指南（机器人、网页应用等）
13
+ - 更多...
14
14
 
15
- ## Installation
15
+ ## 安装
16
16
 
17
- ### Using npx (Recommended)
17
+ ### 使用 npx（推荐）
18
18
 
19
- You can run this MCP server directly using npx without installation:
19
+ 无需安装，直接使用 npx 运行：
20
20
 
21
21
  ```bash
22
22
  npx feishu-doc-mcp
23
23
  ```
24
24
 
25
- ### Global Installation
25
+ ### 全局安装
26
26
 
27
27
  ```bash
28
28
  npm install -g feishu-doc-mcp
29
29
  ```
30
30
 
31
- Then run:
31
+ 然后运行：
32
32
 
33
33
  ```bash
34
34
  feishu-doc-mcp
35
35
  ```
36
36
 
37
- ## Usage with Claude Desktop
37
+ ## 在 Claude Desktop 中使用
38
38
 
39
- Add this to your Claude Desktop configuration file:
39
+ 将以下配置添加到 Claude Desktop 配置文件：
40
40
 
41
41
  **MacOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
42
42
 
@@ -53,7 +53,7 @@ Add this to your Claude Desktop configuration file:
53
53
  }
54
54
  ```
55
55
 
56
- Or if installed globally:
56
+ 如果是全局安装：
57
57
 
58
58
  ```json
59
59
  {
@@ -65,60 +65,59 @@ Or if installed globally:
65
65
  }
66
66
  ```
67
67
 
68
- ## Available Tools
68
+ ## 可用工具
69
69
 
70
70
  ### search_feishu_doc
71
71
 
72
- Search Feishu API documentation by category. Returns a list of documents under the specified category.
72
+ 按分类搜索飞书 API 文档，返回该分类下的文档列表。
73
73
 
74
- **Parameters:**
75
- - `category`: Document category in format "Level1_Level2" (e.g., "服务端API_即时通讯", "开发指南_开发机器人")
74
+ **参数：**
75
+ - `category`: 文档分类，格式为「一级目录_二级目录」（例如：「服务端 API_即时通讯」、「开发指南_开发机器人」）
76
76
 
77
77
  ### read_feishu_doc
78
78
 
79
- Read detailed content of a Feishu API document. The content is saved to a temporary file for easy access.
79
+ 读取飞书 API 文档的详细内容。内容会保存到临时文件以便访问。
80
80
 
81
- **Parameters:**
82
- - `path`: Document path (obtained from search_feishu_doc results)
81
+ **参数：**
82
+ - `path`: 文档路径（从 search_feishu_doc 结果中获取）
83
83
 
84
- ## Development
84
+ ## 开发
85
85
 
86
86
  ```bash
87
- # Install dependencies
87
+ # 安装依赖
88
88
  npm install
89
89
 
90
- # Build
90
+ # 构建
91
91
  npm run build
92
92
 
93
- # Run in development mode
93
+ # 开发模式运行
94
94
  npm run dev
95
95
 
96
- # Start the server
96
+ # 启动服务器
97
97
  npm start
98
98
  ```
99
99
 
100
- ## Publishing
100
+ ## 发布
101
101
 
102
- This project uses GitHub Actions for automatic publishing to npm. To publish a new version:
102
+ 本项目使用 GitHub Actions 自动发布到 npm。发布新版本：
103
103
 
104
- 1. Update the version in `package.json`
105
- 2. Commit your changes
106
- 3. Create and push a tag:
104
+ 1. 更新 `package.json` 中的版本号
105
+ 2. 提交更改
106
+ 3. 创建并推送 tag：
107
107
  ```bash
108
108
  git tag v1.0.1
109
109
  git push origin v1.0.1
110
110
  ```
111
- 4. GitHub Actions will automatically build and publish to npm
111
+ 4. GitHub Actions 会自动构建并发布到 npm
112
112
 
113
- ## Requirements
113
+ ## 环境要求
114
114
 
115
115
  - Node.js >= 18
116
116
 
117
- ## License
117
+ ## 许可证
118
118
 
119
119
  MIT
120
120
 
121
- ## Author
121
+ ## 作者
122
122
 
123
123
  ztxtxwd
124
-
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "feishu-doc-mcp",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "MCP server for Feishu Open Platform Documentation",
5
5
  "type": "module",
6
6
  "main": "build/index.js",