mcpField
D
dingtalk-contact

dingtalk-contact

github.com/breath57Productivity102321 installsUpdated 18w ago
Repository

About dingtalk-contact

A skill for Agents querying DingTalk contacts, with task-specific workflows for user and department lookups. It guides configuration checks, token retrieval, and API execution through a helper script.

Key features

  1. 01Search users and retrieve details
  2. 02Search departments and list members
  3. 03Look up department paths and employee counts
  4. 04Validate settings and retrieve tokens per task

Use cases

  1. 01Find an employee by name and view their details
  2. 02List department members or inspect department details
  3. 03Convert a unionId to a userId
  4. 04Count employees in an organization

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/breath57/dingtalk-skills --skill dingtalk-contact

After installing, type/dingtalk-contactin Claude Code to confirm it loaded.

Bundled filesreferences/api.mdscripts/dt_helper.sh

Details

From the project README

钉钉通讯录技能

负责钉钉通讯录的所有查询操作。本文件为策略指南,仅包含决策逻辑和工作流程。完整 API 请求格式见文末「references/api.md 查阅索引」。

dt_helper.sh 位于本 SKILL.md 同级目录的 scripts/dt_helper.sh。

工作流程(每次执行前)

  1. 先识别本次任务类型 → 例如:搜索用户、查用户详情、搜索部门、列部门成员、查部门路径、统计员工数
  2. 按本次任务校验所需配置 → 通过 bash scripts/dt_helper.sh --get KEY 读取;仅校验本任务必须项
  3. 仅收集缺失配置 → 若缺少某项,一次性询问用户所有缺失值,用 bash scripts/dt_helper.sh --set KEY=VALUE 写入
  4. 获取 Token → 直接调用 bash scripts/dt_helper.sh
  5. 执行操作 → 复杂的创建临时文件再执行,简单的直接执行;禁止 heredoc
按任务校验配置(必须先做)
  • 所有任务通用必需:DINGTALK_APP_KEY、DINGTALK_APP_SECRET
  • 需要“以当前操作者为起点”或“直接读取本人身份信息”的任务:必须有 DINGTALK_MY_USER_ID

规则:未通过“本次任务配置校验”前,不得进入 API 调用步骤。

凭证禁止在输出中完整打印,确认时仅显示前 4 位 + ****

所需配置
配置键必填说明如何获取
DINGTALK_APP_KEY✅应用 AppKey钉钉开放平台 → 应用管理 → 凭证信息
DINGTALK_APP_SECRET✅应用 AppSecret同上
DINGTALK_MY_USER_ID❌当前操作用户的 userId(即运行此技能的人自己),仅在需要以自身为起点查询时才需要管理后台 → 通讯录 → 成员管理 → 点击姓名查看
身份标识说明
标识说明
userId(= staffId)企业内部员工 ID,可通过通过管理后台 -> 通讯录 -> 成员管理 -> 点击姓名查看
unionId跨企业/跨应用唯一标识,可通过 bash scripts/dt_helper.sh --to-unionid <userid> 获取
执行脚本模板
#!/bin/bash
set -e
HELPER="./scripts/dt_helper.sh"
NEW_TOKEN=$(bash "$HELPER" --token)       # api.dingtalk.com 接口用
OLD_TOKEN=$(bash "$HELPER" --old-token)   # oapi.dingtalk.com 接口用
# USER_ID=$(bash "$HELPER" --get DINGTALK_MY_USER_ID)  # 以当前操作用户为起点时启用

# 在此追加具体 API 调用,例如按姓名搜索用户并获取详情:
KEYWORD="张三"
SEARCH=$(curl -s -X POST https://api.dingtalk.com/v1.0/contact/users/search \
  -H "x-acs-dingtalk-access-token: $NEW_TOKEN" \
  -H 'Content-Type: application/json' \
  -d "{\"queryWord\":\"$KEYWORD\",\"offset\":0,\"size\":20}")
echo "搜索结果: $SEARCH"

TARGET_UID=$(echo "$SEARCH" | grep -o '"list":\["[^"]*"' | grep -o '"[^"]*"$' | tr -d '"')
DETAIL=$(curl -s -X POST "https://oapi.dingtalk.com/topapi/v2/user/get?access_token=${OLD_TOKEN}" \
  -H 'Content-Type: application/json' \
  -d "{\"userid\":\"$TARGET_UID\",\"language\":\"zh_CN\"}")
echo "用户详情: $DETAIL"

Token 失效处理:dt_helper 仅按时间缓存,无法感知 token 被提前吊销。若 API 返回 errcode 40001/40014(token 无效/过期),用 --nocache 跳过缓存强制重新获取:

OLD_TOKEN=$(bash "$HELPER" --old-token --nocache)  # 强制重新获取旧版 token
NEW_TOKEN=$(bash "$HELPER" --token --nocache)       # 强制重新获取新版 token

references/api.md 查阅索引

确定好要做什么之后,用以下命令从 references/api.md 中提取对应章节的完整 API 细节(请求格式、参数说明、返回值示例):

grep -A 30 "^## 1. 按关键词搜索用户" references/api.md
grep -A 50 "^## 2. 获取用户完整详情" references/api.md
grep -A 20 "^## 3. unionId → userId 转换" references/api.md
grep -A 18 "^## 4. 企业员工总人数" references/api.md
grep -A 25 "^## 5. 按关键词搜索部门" references/api.md
grep -A 25 "^## 6. 获取子部门列表" references/api.md
grep -A 20 "^## 7. 获取子部门 ID 列表" references/api.md
grep -A 25 "^## 8. 获取部门详情" references/api.md
grep -A 40 "^## 9. 获取部门成员完整列表" references/api.md
grep -A 18 "^## 10. 获取部门成员 userId 列表" references/api.md
grep -A 20 "^## 11. 获取用户所在部门路径" references/api.md
grep -A 12 "^## 错误码" references/api.md
grep -A 6 "^## 所需应用权限" references/api.md

Comments

Markdown supported