mcpField
U
use-pingcode-cli

use-pingcode-cli

github.com/pingcode-orgOther19 installsUpdated today
Repository

About use-pingcode-cli

Use the installed pc CLI to query or modify PingCode projects, work items, product requirements, tickets, tests, knowledge bases, organizational data, and the Nexus application platform API. Use when the user wants to complete tasks in PingCode or configure PingCode CLI login.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/pingcode-org/pingcode-skills --skill use-pingcode-cli

After installing, type/use-pingcode-cliin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
api-docs.md
authentication.md
common.md
fields.md
nexus.md
organization.md
pjm.md
query.md
rate-limits.md
ship.md
testhub.md
wiki.md

Details

From the project README

使用 PingCode CLI

将用户的 PingCode 任务转成命令,并验证结果。在任意目录调用已安装的 pc,无需 CLI 源码或 Rust。本 skill 面向 REST API v2;资料链接相对于所在文件解析。

检查 CLI

本次对话首次执行任务前运行 pc --version。安装、登录或旧版兼容问题见鉴权与配置。命令和参数以所用 CLI 的帮助为准,缺少能力时说明限制,不编造命令或假定升级可解决。

已知命令时直接读操作帮助,如 pc pjm workitem create --help;不确定时,从最近的已知资源或模块逐级查找,必要时才读 pc --help。同一任务复用已读帮助,更换 CLI 版本后重新核对。

按任务读取参考资料

任务参考资料
请求字段、scope、响应结构或 API 语义API 文档检索
登录、配置、鉴权或连通性问题鉴权与配置
筛选、搜索、日期范围、分页或大结果集查询与分页
字典 ID、状态流转、自定义属性或日期值字段取值
项目、工作项、迭代、看板、发布及配置项目管理
产品、需求、工单或客户产品、需求与工单
测试库、用例、套件、计划或执行测试管理
知识库空间、页面或空间成员知识库空间与页面
企业身份、用户、部门、团队、角色或职位组织数据
评论、附件、关联、工时、评审等共享资源,或部分成功共享资源与错误处理
HTTP 429、请求节奏或重试限流与重试
Nexus 存储、Webhook、队列、实时通道或自定义 APINexus 平台与 Exposer

只读当前操作需要的主题或小节;遇到跨主题需求再补充,不递归遍历所有链接。同一任务复用已读规则。各主题的“Docs”均按文档检索规则查生产 llms.txt → 操作的官方页面 → 官方站内搜索,不使用 alpha。

执行用户任务

  1. 本次对话首次执行 API 任务前运行 pc doctor;更换 API 地址、登录或执行环境时重跑。提示未登录或凭据不可读时,先按鉴权资料排查沙箱与宿主环境差异,不直接要求重新登录。后续命令沿用已验证且获准的执行环境;可选身份 scope 警告不等于登录无效。已知 ID 的离线 --dry-run 和本地配置操作无需联网预检。
  2. 按操作帮助确定参数;JSON 请求体按 API 文档检索规则核对,本地示例不能替代契约。字段无法确认时先完成有用的读取,在受影响的写入前说明缺口。
  3. 用读命令将名称解析为 ID,使用用户提供或 API 返回的值,歧义需确认。已知 ID 或完整编号优先 get。只有帮助支持时才传分页参数;一页结果不能证明对象不存在。
  4. 实际写入前重新查询已有目标及本次决策依赖的数据;缺少字段先补读,不从摘要或旧缓存推断写入条件,详见查询资料。执行授权操作,用户要求预览时用 --dry-run;离线预览可跳过联网检查,但须说明当前数据未验证。JSON 对象经 --data 传入,支持内联、@file.json、@- stdin;请求体文件放临时目录。上传参数以操作帮助为准。
  5. 检查返回结果;写后用新请求验证可查询的结果,不能复用写前缓存。无法查询的异步结果按模块规则报告完成边界。汇报相关 ID、URL 和字段;dry-run 仅验证本地构造,不能证明服务端已执行。

控制输出与处理错误

  • 业务 stdout 为 JSON;诊断和 dry-run 预览在 stderr。登录、配置等命令的文本/JSON 差异见鉴权资料。
  • 大列表、长正文和导出先保存到临时文件,再按任务字段筛选、汇总;保留原文来源、分页完整性、失败项和退出码,详见查询资料。摘要缺字段不代表原值为空,不能将摘要作为写请求模板。
  • 错误保留 HTTP 状态与业务码,不一律归为凭据无效。批量请求检查每项 state;HTTP 成功也可能有单项失败,退出码 2 不代表全部失败。
  • 安全读优先使用 CLI 的 --retries / --max-retry-wait,不叠加 Agent 重试循环。写入结果不确定时先读取确认,不整批重放,详见限流资料。
  • 仅排障时使用 -v / --verbose。不得在回复中复述密钥或让用户在聊天中粘贴密钥。配置来自已保存的设置和登录,不读取 PC_* 或 .env。

Skill 目录属于安装内容,不要将运行笔记、凭据或用户数据写入其中。

Comments

Markdown supported