Skip to content

feat: add in-repo maa-cli agent skill - #578

Open
LucasIcarus wants to merge 4 commits into
MaaAssistantArknights:mainfrom
LucasIcarus:feat/agent-skill
Open

LucasIcarus wants to merge 4 commits into
MaaAssistantArknights:mainfrom
LucasIcarus:feat/agent-skill

Conversation

@LucasIcarus

@LucasIcarus LucasIcarus commented Aug 20, 2026 •

Copy link
Copy Markdown

Summary

Add an in-repo agent skill so a coding agent can install, connect, and run maa-cli without relying on chat history. The skill is the end-user CLI runbook; AGENTS.md stays the crate-contribution guide.

Changes

  • add skills/maa-cli/ with SKILL.md (cold-start and command routing), setup.md (install and per-platform runtime), and reference.md (task types and recognition limits)
  • link the skill from the root README and the Simplified Chinese intro
  • document in AGENTS.md when to update the skill versus when to read it instead of this file

Validation

  • markdownlint-cli2 --config .markdownlint.yaml on the skill files, README.md, AGENTS.md, and crates/maa-cli/docs/zh-CN/intro.md
  • git diff --check

Summary by Sourcery

提供一个自包含的代理运行手册,用于安装、连接和运行 maa-cli,而不依赖对话上下文。

新特性:

  • 在仓库中新增 maa-cli 代理技能,覆盖安装、运行时设置、连接配置、命令路由、任务类型以及识别限制等内容。

增强:

  • 明确区分终端用户的 maa-cli 使用指南、crate 贡献指南以及尚未实现的设计提案。
  • 从英文和简体中文的项目介绍中链接到 maa-cli 技能。

文档:

  • 记录平台相关的 maa-cli 安装和运行时要求、连接故障排查、支持的客户端以及任务行为。
Original summary in English

Summary by Sourcery

Provide a self-contained agent runbook for installing, connecting, and operating maa-cli without relying on conversation context.

New Features:

  • Add an in-repository maa-cli agent skill covering installation, runtime setup, connection profiles, command routing, task types, and recognition limits.

Enhancements:

  • Clarify the separation between end-user maa-cli operation guidance, crate contribution guidance, and unimplemented design proposals.
  • Link the maa-cli skill from the English and Simplified Chinese project introductions.

Documentation:

  • Document platform-specific maa-cli installation and runtime requirements, connection troubleshooting, supported clients, and task behavior.
Original summary in English

Summary by Sourcery

提供一个自包含的代理运行手册,用于安装、连接和运行 maa-cli,而不依赖对话上下文。

新特性:

  • 在仓库中新增 maa-cli 代理技能,覆盖安装、运行时设置、连接配置、命令路由、任务类型以及识别限制等内容。

增强:

  • 明确区分终端用户的 maa-cli 使用指南、crate 贡献指南以及尚未实现的设计提案。
  • 从英文和简体中文的项目介绍中链接到 maa-cli 技能。

文档:

  • 记录平台相关的 maa-cli 安装和运行时要求、连接故障排查、支持的客户端以及任务行为。
Original summary in English

Summary by Sourcery

Provide a self-contained agent runbook for installing, connecting, and operating maa-cli without relying on conversation context.

New Features:

  • Add an in-repository maa-cli agent skill covering installation, runtime setup, connection profiles, command routing, task types, and recognition limits.

Enhancements:

  • Clarify the separation between end-user maa-cli operation guidance, crate contribution guidance, and unimplemented design proposals.
  • Link the maa-cli skill from the English and Simplified Chinese project introductions.

Documentation:

  • Document platform-specific maa-cli installation and runtime requirements, connection troubleshooting, supported clients, and task behavior.
Original summary in English

Summary by Sourcery

提供一个自包含的代理运行手册,用于安装、连接和运行 maa-cli,而不依赖对话上下文。

新特性:

  • 在仓库中新增 maa-cli 代理技能,覆盖安装、运行时设置、连接配置、命令路由、任务类型以及识别限制等内容。

增强:

  • 明确区分终端用户的 maa-cli 使用指南、crate 贡献指南以及尚未实现的设计提案。
  • 从英文和简体中文的项目介绍中链接到 maa-cli 技能。

文档:

  • 记录平台相关的 maa-cli 安装和运行时要求、连接故障排查、支持的客户端以及任务行为。
Original summary in English

Summary by Sourcery

Provide a self-contained agent runbook for installing, connecting, and operating maa-cli without relying on conversation context.

New Features:

  • Add an in-repository maa-cli agent skill covering installation, runtime setup, connection profiles, command routing, task types, and recognition limits.

Enhancements:

  • Clarify the separation between end-user maa-cli operation guidance, crate contribution guidance, and unimplemented design proposals.
  • Link the maa-cli skill from the English and Simplified Chinese project introductions.

Documentation:

  • Document platform-specific maa-cli installation and runtime requirements, connection troubleshooting, supported clients, and task behavior.
Original summary in English

Summary by Sourcery

提供一个自包含的代理运行手册,用于安装、连接和运行 maa-cli,而不依赖对话上下文。

新特性:

  • 在仓库中新增 maa-cli 代理技能,覆盖安装、运行时设置、连接配置、命令路由、任务类型以及识别限制等内容。

增强:

  • 明确区分终端用户的 maa-cli 使用指南、crate 贡献指南以及尚未实现的设计提案。
  • 从英文和简体中文的项目介绍中链接到 maa-cli 技能。

文档:

  • 记录平台相关的 maa-cli 安装和运行时要求、连接故障排查、支持的客户端以及任务行为。
Original summary in English

Summary by Sourcery

Provide a self-contained agent runbook for installing, connecting, and operating maa-cli without relying on conversation context.

New Features:

  • Add an in-repository maa-cli agent skill covering installation, runtime setup, connection profiles, command routing, task types, and recognition limits.

Enhancements:

  • Clarify the separation between end-user maa-cli operation guidance, crate contribution guidance, and unimplemented design proposals.
  • Link the maa-cli skill from the English and Simplified Chinese project introductions.

Documentation:

  • Document platform-specific maa-cli installation and runtime requirements, connection troubleshooting, supported clients, and task behavior.
Original summary in English

Summary by Sourcery

提供一个自包含的代理运行手册,用于安装、连接和运行 maa-cli,而不依赖对话上下文。

新特性:

  • 在仓库中新增 maa-cli 代理技能,覆盖安装、运行时设置、连接配置、命令路由、任务类型以及识别限制等内容。

增强:

  • 明确区分终端用户的 maa-cli 使用指南、crate 贡献指南以及尚未实现的设计提案。
  • 从英文和简体中文的项目介绍中链接到 maa-cli 技能。

文档:

  • 记录平台相关的 maa-cli 安装和运行时要求、连接故障排查、支持的客户端以及任务行为。
Original summary in English

Summary by Sourcery

Provide a self-contained agent runbook for installing, connecting, and operating maa-cli without relying on conversation context.

New Features:

  • Add an in-repository maa-cli agent skill covering installation, runtime setup, connection profiles, command routing, task types, and recognition limits.

Enhancements:

  • Clarify the separation between end-user maa-cli operation guidance, crate contribution guidance, and unimplemented design proposals.
  • Link the maa-cli skill from the English and Simplified Chinese project introductions.

Documentation:

  • Document platform-specific maa-cli installation and runtime requirements, connection troubleshooting, supported clients, and task behavior.
Original summary in English

Summary by Sourcery

提供一个自包含的代理运行手册,用于安装、连接和运行 maa-cli,而不依赖对话上下文。

新特性:

  • 在仓库中新增 maa-cli 代理技能,覆盖安装、运行时设置、连接配置、命令路由、任务类型以及识别限制等内容。

增强:

  • 明确区分终端用户的 maa-cli 使用指南、crate 贡献指南以及尚未实现的设计提案。
  • 从英文和简体中文的项目介绍中链接到 maa-cli 技能。

文档:

  • 记录平台相关的 maa-cli 安装和运行时要求、连接故障排查、支持的客户端以及任务行为。
Original summary in English

Summary by Sourcery

Provide a self-contained agent runbook for installing, connecting, and operating maa-cli without relying on conversation context.

New Features:

  • Add an in-repository maa-cli agent skill covering installation, runtime setup, connection profiles, command routing, task types, and recognition limits.

Enhancements:

  • Clarify the separation between end-user maa-cli operation guidance, crate contribution guidance, and unimplemented design proposals.
  • Link the maa-cli skill from the English and Simplified Chinese project introductions.

Documentation:

  • Document platform-specific maa-cli installation and runtime requirements, connection troubleshooting, supported clients, and task behavior.
Original summary in English

Summary by Sourcery

提供一个自包含的代理运行手册,用于安装、连接和运行 maa-cli,而不依赖对话上下文。

新特性:

  • 在仓库中新增 maa-cli 代理技能,覆盖安装、运行时设置、连接配置、命令路由、任务类型以及识别限制等内容。

增强:

  • 明确区分终端用户的 maa-cli 使用指南、crate 贡献指南以及尚未实现的设计提案。
  • 从英文和简体中文的项目介绍中链接到 maa-cli 技能。

文档:

  • 记录平台相关的 maa-cli 安装和运行时要求、连接故障排查、支持的客户端以及任务行为。
Original summary in English

Summary by Sourcery

Provide a self-contained agent runbook for installing, connecting, and operating maa-cli without relying on conversation context.

New Features:

  • Add an in-repository maa-cli agent skill covering installation, runtime setup, connection profiles, command routing, task types, and recognition limits.

Enhancements:

  • Clarify the separation between end-user maa-cli operation guidance, crate contribution guidance, and unimplemented design proposals.
  • Link the maa-cli skill from the English and Simplified Chinese project introductions.

Documentation:

  • Document platform-specific maa-cli installation and runtime requirements, connection troubleshooting, supported clients, and task behavior.
Original summary in English

Summary by Sourcery

提供一个自包含的代理运行手册,用于安装、连接和运行 maa-cli,而不依赖对话上下文。

新特性:

  • 在仓库中新增 maa-cli 代理技能,覆盖安装、运行时设置、连接配置、命令路由、任务类型以及识别限制等内容。

增强:

  • 明确区分终端用户的 maa-cli 使用指南、crate 贡献指南以及尚未实现的设计提案。
  • 从英文和简体中文的项目介绍中链接到 maa-cli 技能。

文档:

  • 记录平台相关的 maa-cli 安装和运行时要求、连接故障排查、支持的客户端以及任务行为。
Original summary in English

Summary by Sourcery

Provide a self-contained agent runbook for installing, connecting, and operating maa-cli without relying on conversation context.

New Features:

  • Add an in-repository maa-cli agent skill covering installation, runtime setup, connection profiles, command routing, task types, and recognition limits.

Enhancements:

  • Clarify the separation between end-user maa-cli operation guidance, crate contribution guidance, and unimplemented design proposals.
  • Link the maa-cli skill from the English and Simplified Chinese project introductions.

Documentation:

  • Document platform-specific maa-cli installation and runtime requirements, connection troubleshooting, supported clients, and task behavior.

Give agents a usage guide for running maa-cli instead of scraping --help, including command routing and Depot/OperBox OCR limits.
Give a bare agent enough runtime context to install, connect, and run maa-cli, and point AGENTS.md at the skill for end-user usage versus crate work.
OCR acquisition and on-demand query are the product; shop advice is only one consumer of those facts.
@LucasIcarus
LucasIcarus marked this pull request as ready for review August 20, 2026 05:48

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - 我在这里给出一些整体上的反馈:

  • 在 skills/maa-cli/setup.md 和 SKILL.md 中,你通过硬编码的 GitHub URL 链接到 install.md / config.md;建议改成仓库相对路径,这样在不同分支和 fork 间也能保持正确。
  • 连接预设(connection preset)的表格和说明在 setup.md 和 SKILL.md 之间是重复的;你可能希望将它们整合为单一来源(或者在其中一个文件中显式引用另一个),以减少随时间推移出现指引不一致的风险。
给 AI Agent 的提示词
Please address the comments from this code review:

## Overall Comments
- In `skills/maa-cli/setup.md` and `SKILL.md` you link to `install.md`/`config.md` via hard-coded GitHub URLs; consider switching these to repo-relative paths so they stay correct across branches and forks.
- The connection preset tables/descriptions are duplicated between `setup.md` and `SKILL.md`; you might want to consolidate this into a single source (or explicitly reference one from the other) to reduce the chance of the guidance drifting over time.

Sourcery 对开源项目是免费的——如果你觉得我们的评审有帮助,欢迎分享给更多人 ✨
帮我变得更有用!请在每条评论上点 👍 或 👎,我会根据这些反馈改进后续的评审。
Original comment in English

Hey - I've left some high level feedback:

  • In skills/maa-cli/setup.md and SKILL.md you link to install.md/config.md via hard-coded GitHub URLs; consider switching these to repo-relative paths so they stay correct across branches and forks.
  • The connection preset tables/descriptions are duplicated between setup.md and SKILL.md; you might want to consolidate this into a single source (or explicitly reference one from the other) to reduce the chance of the guidance drifting over time.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In `skills/maa-cli/setup.md` and `SKILL.md` you link to `install.md`/`config.md` via hard-coded GitHub URLs; consider switching these to repo-relative paths so they stay correct across branches and forks.
- The connection preset tables/descriptions are duplicated between `setup.md` and `SKILL.md`; you might want to consolidate this into a single source (or explicitly reference one from the other) to reduce the chance of the guidance drifting over time.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Keep preset routing in SKILL.md and profile templates in setup.md so the two files stop drifting.
@LucasIcarus

Copy link
Copy Markdown
Author

Thanks for the review — both points are in c5de274:

  1. Relative links: SKILL.md / setup.md now point at the in-repo manuals (crates/maa-cli/docs/zh-CN/…), and reference.md uses the in-repo task schema. Download URLs (install.sh / install.ps1) stay on GitHub because those are fetch targets, not docs.
  2. Connection docs: the preset routing table lives only in SKILL.md; full profile templates live only in setup.md. The two files cross-link so they do not duplicate each other.

This branch is already based on current main (aebb5e9); no rebase needed.

@wangl-cc

Copy link
Copy Markdown
Member

这个是典型的 GPT 写的文档,基本上是把对话的内容搬了进去,真正的 skill 不是这么写的。

@LucasIcarus

Copy link
Copy Markdown
Author

@wangl-cc 你指的是 skill 的正文还是 design doc?

@wangl-cc

Copy link
Copy Markdown
Member

文档的 AI 味很重, skill 本身稍微好一点。我觉得确实可以写一个 skill,但是现在这个版本可能还是要进一步的完善修改一下。你可以开一个新的 session 或者开一个新的 sub agent,让他们注意一下语气,以及要写的目标。

@LucasIcarus

Copy link
Copy Markdown
Author

文档的 AI 味很重, skill 本身稍微好一点。我觉得确实可以写一个 skill,但是现在这个版本可能还是要进一步的完善修改一下。你可以开一个新的 session 或者开一个新的 sub agent,让他们注意一下语气,以及要写的目标。

design spec 确实是 agent 直出的, 我大概 prompt 了下终态目标..

我先优化下 skill 本身, 然后把 design spec untrack 下吧.. 不过 skill 目前也只是个壳子 我考虑本地 dogfooding 加些功能先

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants