dingtalk-wiki 1.1.1 → 1.1.2

package/README.md

@@ -38,36 +38,21 @@ All config goes into one JSON block — no local files needed:
       "env": {
         "DINGTALK_APP_KEY": "your-app-key",
         "DINGTALK_APP_SECRET": "your-app-secret",
-        "DINGTALK_WIKI_CONFIG": {
-          "defaultUser": "me",
-          "users": {
-            "me": { "name": "Your Name", "userId": "your-user-id" }
-          },
-          "workspaces": {
-            "My Workspace": {
-              "id": "your_workspace_id",
-              "url": "https://alidocs.dingtalk.com/i/spaces/.../overview",
-              "type": "TEAM"
-            }
-          }
-        }
+        "DINGTALK_WIKI_CONFIG": "{\"defaultUser\":\"me\",\"users\":{\"me\":{\"userId\":\"your-user-id\"}}}"
       }
     }
   }
 }
 ```
 
-> `DINGTALK_WIKI_CONFIG` 支持两种写法：
-> - **JSON 对象**（如上）— MCP 客户端自动处理，**推荐**
-> - **JSON 字符串** — shell export 时必须用，如 `"{\"defaultUser\":\"me\",...}"`
 
-| env var | 说明 |
+| env var | Description |
 |---------|------|
-| `DINGTALK_APP_KEY` | 钉钉应用 AppKey |
-| `DINGTALK_APP_SECRET` | 钉钉应用 AppSecret |
-| `DINGTALK_WIKI_CONFIG` | 用户/知识库配置（JSON），必填 |
+| `DINGTALK_APP_KEY` | DingTalk App Key |
+| `DINGTALK_APP_SECRET` | DingTalk App Secret |
+| `DINGTALK_WIKI_CONFIG` | User/workspace config (JSON string), required |
 
-首次调用时程序自动通过 `userId` 获取 `unionId` 并缓存到 `~/.cache/dingtalk-wiki-mcp/`，后续启动不再重复请求。
+On first call the server auto-fetches `unionId` via `userId` and caches it to `~/.cache/dingtalk-wiki-mcp/`.
 
 Then call tools as `dingtalk-wiki.list_wiki_workspaces` (namespaced).
 
@@ -306,7 +291,6 @@ Please refer to DingTalk Open Platform documentation for the latest permission n
 - [Changelog](./CHANGELOG.md)
 - [API test notes](./API_TEST_REPORT.md)
 - [Skill definition](./skill/SKILL.md)
-- [Skill reference (Chinese)](./docs/skill-reference.md)
 
 ---
 

package/README.zh-CN.md

@@ -38,34 +38,20 @@
       "env": {
         "DINGTALK_APP_KEY": "your-app-key",
         "DINGTALK_APP_SECRET": "your-app-secret",
-        "DINGTALK_WIKI_CONFIG": {
-          "defaultUser": "me",
-          "users": {
-            "me": { "name": "Your Name", "userId": "your-user-id" }
-          },
-          "workspaces": {
-            "My Workspace": {
-              "id": "your_workspace_id",
-              "url": "https://alidocs.dingtalk.com/i/spaces/.../overview",
-              "type": "TEAM"
-            }
-          }
-        }
+        "DINGTALK_WIKI_CONFIG": "{\"defaultUser\":\"me\",\"users\":{\"me\":{\"userId\":\"your-user-id\"}}}"
       }
     }
   }
 }
 ```
 
-> `DINGTALK_WIKI_CONFIG` 支持两种写法：
-> - **JSON 对象**（如上）— MCP 客户端自动处理，**推荐**
-> - **JSON 字符串** — shell export 时必须用，如 `"{\"defaultUser\":\"me\",...}"`
+> `DINGTALK_WIKI_CONFIG` 必须是 JSON **字符串**（MCP 客户端 env 字段只接受 string 类型）。
 
 | 环境变量 | 说明 |
 |---------|------|
 | `DINGTALK_APP_KEY` | 钉钉应用 AppKey |
 | `DINGTALK_APP_SECRET` | 钉钉应用 AppSecret |
-| `DINGTALK_WIKI_CONFIG` | 用户/知识库配置（JSON），必填 |
+| `DINGTALK_WIKI_CONFIG` | 用户/知识库配置（JSON 字符串），必填 |
 
 首次调用时程序自动通过 `userId` 获取 `unionId` 并缓存到 `~/.cache/dingtalk-wiki-mcp/`，后续启动不再重复请求。
 

package/assets/demo-create-doc.svg

@@ -0,0 +1,18 @@
+<svg width="1280" height="720" viewBox="0 0 1280 720" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <rect width="1280" height="720" rx="24" fill="#0B1020"/>
+  <rect x="40" y="40" width="1200" height="640" rx="20" fill="#111827" stroke="#334155"/>
+  <circle cx="84" cy="82" r="10" fill="#EF4444"/>
+  <circle cx="116" cy="82" r="10" fill="#F59E0B"/>
+  <circle cx="148" cy="82" r="10" fill="#10B981"/>
+  <text x="190" y="89" fill="#CBD5E1" font-size="24" font-family="ui-monospace, monospace">Demo 3 · Create a Wiki Document</text>
+  <text x="80" y="150" fill="#93C5FD" font-size="24" font-family="ui-monospace, monospace">$ mcporter call dingtalk-wiki.create_wiki_doc workspace_id="workspace_product_demo" name="Weekly Summary"</text>
+  <text x="80" y="225" fill="#86EFAC" font-size="22" font-family="ui-monospace, monospace">✅ Document created successfully</text>
+  <text x="80" y="285" fill="#E2E8F0" font-size="20" font-family="ui-monospace, monospace">📄 Weekly Summary</text>
+  <text x="120" y="330" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">Node ID: node_weekly_summary_demo</text>
+  <text x="120" y="365" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">DocKey: doc_key_demo</text>
+  <text x="120" y="400" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">Workspace ID: workspace_product_demo</text>
+  <text x="120" y="435" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">Type: DOC</text>
+  <rect x="80" y="500" width="900" height="88" rx="12" fill="#0F172A" stroke="#1E293B"/>
+  <text x="110" y="548" fill="#93C5FD" font-size="18" font-family="ui-monospace, monospace">Typical follow-up: create DOC / WORKBOOK / MIND / FOLDER in the same workflow</text>
+  <text x="80" y="635" fill="#64748B" font-size="18" font-family="ui-monospace, monospace">Illustrative demo output for repository documentation</text>
+</svg>

package/assets/demo-list-nodes.svg

@@ -0,0 +1,20 @@
+<svg width="1280" height="720" viewBox="0 0 1280 720" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <rect width="1280" height="720" rx="24" fill="#0B1020"/>
+  <rect x="40" y="40" width="1200" height="640" rx="20" fill="#111827" stroke="#334155"/>
+  <circle cx="84" cy="82" r="10" fill="#EF4444"/>
+  <circle cx="116" cy="82" r="10" fill="#F59E0B"/>
+  <circle cx="148" cy="82" r="10" fill="#10B981"/>
+  <text x="190" y="89" fill="#CBD5E1" font-size="24" font-family="ui-monospace, monospace">Demo 2 · Browse Workspace Nodes</text>
+  <text x="80" y="150" fill="#93C5FD" font-size="24" font-family="ui-monospace, monospace">$ mcporter call dingtalk-wiki.list_wiki_nodes workspace_id="workspace_product_demo"</text>
+  <text x="80" y="210" fill="#E2E8F0" font-size="22" font-family="ui-monospace, monospace">📄 Workspace nodes (4)</text>
+  <text x="80" y="265" fill="#FDE68A" font-size="20" font-family="ui-monospace, monospace">1. 📁 Weekly Reports</text>
+  <text x="120" y="300" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">ID: node_weekly_reports_demo</text>
+  <text x="120" y="330" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">Type: FOLDER · Has children: yes</text>
+  <text x="80" y="390" fill="#A7F3D0" font-size="20" font-family="ui-monospace, monospace">2. 📄 Product Overview</text>
+  <text x="120" y="425" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">ID: node_product_overview_demo</text>
+  <text x="120" y="455" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">Type: FILE · Has children: no</text>
+  <text x="80" y="515" fill="#A7F3D0" font-size="20" font-family="ui-monospace, monospace">3. 📄 Release Checklist</text>
+  <text x="120" y="550" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">ID: node_release_checklist_demo</text>
+  <text x="120" y="580" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">Type: FILE · Has children: no</text>
+  <text x="80" y="635" fill="#64748B" font-size="18" font-family="ui-monospace, monospace">Illustrative demo output for repository documentation</text>
+</svg>

package/assets/demo-list-workspaces.svg

@@ -0,0 +1,20 @@
+<svg width="1280" height="720" viewBox="0 0 1280 720" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <rect width="1280" height="720" rx="24" fill="#0B1020"/>
+  <rect x="40" y="40" width="1200" height="640" rx="20" fill="#111827" stroke="#334155"/>
+  <circle cx="84" cy="82" r="10" fill="#EF4444"/>
+  <circle cx="116" cy="82" r="10" fill="#F59E0B"/>
+  <circle cx="148" cy="82" r="10" fill="#10B981"/>
+  <text x="190" y="89" fill="#CBD5E1" font-size="24" font-family="ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace">Demo 1 · List Wiki Workspaces</text>
+  <text x="80" y="150" fill="#93C5FD" font-size="24" font-family="ui-monospace, monospace">$ mcporter call dingtalk-wiki.list_wiki_workspaces</text>
+  <text x="80" y="210" fill="#E2E8F0" font-size="22" font-family="ui-monospace, monospace">📚 Wiki workspaces (3)</text>
+  <text x="80" y="260" fill="#A7F3D0" font-size="20" font-family="ui-monospace, monospace">1. Product Knowledge Base</text>
+  <text x="120" y="295" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">ID: workspace_product_demo</text>
+  <text x="120" y="325" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">Type: TEAM</text>
+  <text x="80" y="385" fill="#A7F3D0" font-size="20" font-family="ui-monospace, monospace">2. Engineering Wiki</text>
+  <text x="120" y="420" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">ID: workspace_engineering_demo</text>
+  <text x="120" y="450" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">Type: TEAM</text>
+  <text x="80" y="510" fill="#A7F3D0" font-size="20" font-family="ui-monospace, monospace">3. Operations Docs</text>
+  <text x="120" y="545" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">ID: workspace_ops_demo</text>
+  <text x="120" y="575" fill="#CBD5E1" font-size="18" font-family="ui-monospace, monospace">Type: TEAM</text>
+  <text x="80" y="635" fill="#64748B" font-size="18" font-family="ui-monospace, monospace">Illustrative demo output for repository documentation</text>
+</svg>

package/index.js

@@ -310,28 +310,6 @@ const server = new Server(
 server.setRequestHandler(ListToolsRequestSchema, async () => {
   return {
     tools: [
-      {
-        name: 'set_operator',
-        description: '设置操作者 unionid（用于访问 Wiki API）',
-        inputSchema: {
-          type: 'object',
-          properties: {
-            unionid: {
-              type: 'string',
-              description: '用户的 unionid'
-            }
-          },
-          required: ['unionid']
-        }
-      },
-      {
-        name: 'show_config',
-        description: '显示当前配置信息（默认用户和知识库列表）',
-        inputSchema: {
-          type: 'object',
-          properties: {}
-        }
-      },
       {
         name: 'list_wiki_workspaces',
         description: '列出用户有权限的知识库工作空间列表',
@@ -557,50 +535,6 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
 
   try {
     switch (name) {
-      case 'set_operator': {
-        const { unionid } = args;
-        dingtalk.setOperatorId(unionid);
-        return {
-          content: [{
-            type: 'text',
-            text: `✅ 操作者已设置为: ${unionid}`
-          }]
-        };
-      }
-
-      case 'show_config': {
-        let output = '⚙️ 当前配置信息\n\n';
-        
-        output += '👤 默认用户:\n';
-        if (userConfig.defaultUser && userConfig.users) {
-          const user = userConfig.users[userConfig.defaultUser];
-          output += `  姓名: ${user.name}\n`;
-          output += `  User ID: ${user.userId}\n`;
-          output += `  Union ID: ${user.unionId}\n`;
-        } else {
-          output += '  (未配置)\n';
-        }
-        
-        output += '\n📚 知识库列表:\n';
-        if (userConfig.workspaces) {
-          Object.entries(userConfig.workspaces).forEach(([name, info], index) => {
-            output += `  ${index + 1}. ${name}\n`;
-            output += `     ID: ${info.id}\n`;
-          });
-        }
-        
-        output += '\n💡 使用提示:\n';
-        output += '  - list_wiki_workspaces 和 list_wiki_nodes 会自动使用默认 operator_id\n';
-        output += '  - 如需使用其他用户，可传入 operator_id 参数覆盖\n';
-        
-        return {
-          content: [{
-            type: 'text',
-            text: output
-          }]
-        };
-      }
-
       case 'list_wiki_workspaces': {
         if (args.operator_id) {
           dingtalk.setOperatorId(args.operator_id);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dingtalk-wiki",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "DingTalk Wiki / Docs read-write MCP server that fills the gap left by DingTalk official MCP.",
   "main": "index.js",
   "bin": {
@@ -23,6 +23,7 @@
     "javascript"
   ],
   "files": [
+    "assets/",
     "skill/",
     "docs/",
     "index.js",

package/skill/SKILL.md

@@ -17,40 +17,107 @@
 - `get_department_users` - 获取部门成员
 - `get_user_info` - 获取用户详情（包含 `unionid`）
 
-### 配置管理
-- `set_operator` - 设置操作者 `unionid`
-- `show_config` - 显示当前配置信息
-
 ## 使用示例
 
-### 查看当前配置
+### 查看所有工具
 
 ```bash
-mcporter call dingtalk-wiki.show_config
+mcporter list dingtalk-wiki
 ```
 
-### 列出知识库
+### 知识库管理
 
 ```bash
+# 列出知识库工作空间
 mcporter call dingtalk-wiki.list_wiki_workspaces
-```
 
-### 获取某个知识库节点
+# 获取知识库详情
+mcporter call dingtalk-wiki.get_wiki_workspace workspace_id="your_workspace_id"
 
-```bash
+# 列出知识库节点（根目录）
 mcporter call dingtalk-wiki.list_wiki_nodes workspace_id="your_workspace_id"
-```
 
-### 创建文档
+# 列出指定目录下的节点
+mcporter call dingtalk-wiki.list_wiki_nodes workspace_id="your_workspace_id" parent_node_id="folder_node_id"
 
-```bash
+# 创建文档（默认 DOC）
 mcporter call dingtalk-wiki.create_wiki_doc \
   workspace_id="your_workspace_id" \
   name="新文档标题"
+
+# 创建表格
+mcporter call dingtalk-wiki.create_wiki_doc \
+  workspace_id="your_workspace_id" \
+  name="数据统计" \
+  doc_type="WORKBOOK"
+
+# 创建脑图
+mcporter call dingtalk-wiki.create_wiki_doc \
+  workspace_id="your_workspace_id" \
+  name="思维导图" \
+  doc_type="MIND"
+
+# 创建文件夹
+mcporter call dingtalk-wiki.create_wiki_doc \
+  workspace_id="your_workspace_id" \
+  name="项目文档" \
+  doc_type="FOLDER"
+
+# 在指定目录下创建文档
+mcporter call dingtalk-wiki.create_wiki_doc \
+  workspace_id="your_workspace_id" \
+  name="周报" \
+  parent_node_id="folder_node_id"
+
+# 获取节点详情
+mcporter call dingtalk-wiki.get_wiki_node node_id="your_node_id"
+
+# 搜索知识库内容
+mcporter call dingtalk-wiki.search_wiki keyword="项目规划"
+
+# 在指定知识库内搜索
+mcporter call dingtalk-wiki.search_wiki keyword="项目规划" workspace_id="your_workspace_id"
+```
+
+### AI 表格（Notable）
+
+```bash
+# 获取 AI 表格的所有数据表（base_id 通常就是 nodeId）
+mcporter call dingtalk-wiki.list_notable_sheets base_id="your_base_id"
+
+# 获取数据表中的记录
+mcporter call dingtalk-wiki.list_notable_records \
+  base_id="your_base_id" \
+  sheet_id="your_sheet_id"
+
+# 指定返回条数（默认 20）
+mcporter call dingtalk-wiki.list_notable_records \
+  base_id="your_base_id" \
+  sheet_id="your_sheet_id" \
+  max_results=100
+
+# 分页获取
+mcporter call dingtalk-wiki.list_notable_records \
+  base_id="your_base_id" \
+  sheet_id="your_sheet_id" \
+  next_token="your_next_token"
 ```
 
-### 获取用户信息
+### 组织架构
 
 ```bash
+# 列出根部门
+mcporter call dingtalk-wiki.list_departments
+
+# 列出指定部门下的子部门
+mcporter call dingtalk-wiki.list_departments dept_id=123456
+
+# 获取部门成员（默认每页 50 条）
+mcporter call dingtalk-wiki.get_department_users dept_id=123456
+
+# 分页获取部门成员
+mcporter call dingtalk-wiki.get_department_users dept_id=123456 cursor=0 size=100
+
+# 获取用户详情
 mcporter call dingtalk-wiki.get_user_info userid="your_user_id"
 ```

package/docs/skill-reference.md

@@ -1,108 +0,0 @@
-# DingTalk Wiki MCP Server 参考文档
-
-钉钉知识库 MCP Server，支持通过 MCP 协议读写钉钉 Wiki / Docs 内容。
-
-## 功能特性
-
-### 知识库管理
-- `list_wiki_workspaces` - 列出知识库工作空间列表
-- `get_wiki_workspace` - 获取知识库详情
-- `list_wiki_nodes` - 列出知识库节点（文档 / 目录）
-- `get_wiki_node` - 获取节点详情
-- `create_wiki_doc` - 创建文档（支持 `DOC` / `WORKBOOK` / `MIND` / `FOLDER`）
-- `search_wiki` - 搜索知识库内容
-- `list_notable_sheets` - 获取 `.able` / AI 表格中的所有数据表
-- `list_notable_records` - 获取指定数据表中的 records
-
-### 组织架构
-- `list_departments` - 列出部门列表
-- `get_department_users` - 获取部门成员
-- `get_user_info` - 获取用户详情（包含 `unionid`）
-
-### 配置管理
-- `set_operator` - 设置操作者 `unionid`
-- `show_config` - 显示当前配置信息
-
----
-
-## 环境变量
-
-```bash
-cp .env.example .env
-```
-
-填写：
-
-```env
-DINGTALK_APP_KEY=your-app-key
-DINGTALK_APP_SECRET=your-app-secret
-```
-
-可选：
-
-```env
-DINGTALK_WIKI_CONFIG_PATH=/absolute/path/to/config.json
-```
-
-如果不设置 `DINGTALK_WIKI_CONFIG_PATH`，程序默认读取当前目录下的 `config.json`。
-
----
-
-## 配置文件
-
-先复制示例配置：
-
-```bash
-cp config.example.json config.json
-```
-
-然后填入你自己的：
-- 默认用户
-- userId / unionId
-- 常用 workspace 信息
-
----
-
-## 配置文件格式
-
-```json
-{
-  "defaultUser": "your-default-user",
-  "users": {
-    "your-default-user": {
-      "name": "Your Name",
-      "userId": "your-user-id"
-    }
-  },
-  "workspaces": {
-    "Your Workspace": {
-      "id": "your_workspace_id",
-      "url": "https://alidocs.dingtalk.com/i/spaces/your-space-id/overview",
-      "type": "TEAM"
-    }
-  },
-}
-```
-
----
-
-## API 端点
-
-- Wiki API v2.0: `https://api.dingtalk.com/v2.0/wiki`
-- 创建文档: `POST /v1.0/doc/workspaces/{workspaceId}/docs`
-
----
-
-## 注意事项
-
-1. `operator_id` 使用 DingTalk `unionId`
-2. 不传 `operator_id` 时，默认使用配置文件中的默认用户
-3. 只能访问当前账号有权限的知识库
-4. `config.json` 不建议提交到 Git 仓库
-
----
-
-## 相关链接
-
-- [钉钉开放平台 - 知识库概述](https://open.dingtalk.com/document/development/knowledge-base-overview)
-- [Create Team Space Document](https://open.dingtalk.com/document/development/create-team-space-document)