makecindy / makecindy/cindy

[Feature]「仅运行脚本」模式中“允许调用的能力”使用指引

Open
#32 0 comments 0 reactions 0 assignees View on GitHub
feature
Dominant language
TypeScript
Stars
2.7k
Forks
395
Avg merge
21h 48m
Merged PRs (30d)
776

Description

## Subject

体验优化:「仅运行脚本」模式中“允许调用的能力”使用指引

## Detail

### 背景

在自动化任务编辑界面选择「仅运行脚本」后,用户可以通过「允许调用的能力」为脚本授权,例如读取 Jira、评论 Jira、读取飞书消息、派发 Cindy 会话。

### 当前问题

勾选能力实际上只是将能力加入任务的授权白名单,并不会自动在脚本中使用该能力。脚本仍需按照 Cindy 的脚本协议主动发起调用。

由于编辑界面中缺少相关指引,用户容易产生以下困惑:

- 不清楚“勾选能力”只是授权,还是会自动执行对应操作;
- 不知道脚本需要遵循什么协议;
- 不知道能力对应的方法、参数和调用方式;
- 不知道是否存在可以直接参考或复制的示例脚本。

这导致用户即使勾选了相关能力,也很难在自行编写的脚本中实际使用它们。

### 优化建议

建议在自动化任务编辑界面的「仅运行脚本」配置区域,为“允许调用的能力”补充易于访问的使用指引。

具体交互和呈现方式由维护者结合现有设计确定,例如:

- 提供一个可访问或可复制的 demo 脚本;
- 展示简短的协议及调用示例;
- 提供“查看使用说明”入口;
- 链接到线上脚本接入文档;
- 根据已勾选的能力展示对应的方法说明。

指引中至少应明确:

1. 勾选能力仅代表授予脚本调用权限,不会自动使用该能力;
2. 脚本需要通过约定的协议主动调用宿主能力;
3. 用户可以在哪里查看完整文档或获得可运行的示例。

### 期望效果

用户在编辑「仅运行脚本」自动化时,不离开当前操作上下文即可知道:

- “允许调用的能力”的实际含义;
- 如何在脚本中调用已授权能力;
- 从哪里获取可运行的示例或完整文档。

本 Issue 主要关注使用体验和信息可发现性的优化,不限定具体实现方案。

Contributor guide

Open the contributing guide

Research direction

Start by locating the automation task editor entry point for the “仅运行脚本” mode and its “允许调用的能力” configuration. Read the existing Cindy script protocol and any linked capability documentation before choosing the presentation. Done means the editor explains authorization versus execution, shows how to call an allowed capability, and provides a runnable example or complete documentation link.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.