AstrBot-Skill

A skill and docs for building AstrBot plugins: plugin API, events, messages, platform adapters and docs4agent writing rules

  • 77 ★ on the repository
  • Last commit
Skill

Minimal access

Why this level

  • The skill only gives documentation and hints and runs nothing
All reasons and checks

xunxiing/astrbot-skill

Install

In your terminal, with SkillFoxx CLI

npx skillfoxx add skills/astrbot-skill

Detects the agents on your machine, shows the access level and pins the version.

Other ways to install

Access and checks

How we review

Minimal accessThe tool runs nothing and makes no network calls.

  • The skill only gives documentation and hints and runs nothing

This is third-party code. Review the repository files before installing.

What it does

AstrBot-Skill is a repo with the `skill-astrbot-dev` skill and structured technical docs for building plugins for AstrBot, a chatbot framework. A loaded skill lets an agent understand the plugin architecture and API, write plugin code to the accepted rules and help with debugging. The first request in the README: read `skill-astrbot-dev/SKILL.md` and write a plugin that answers "Hello!" to every message. The docs are split into sections: design standards with concepts, architecture and best practices, the agent system with tools, subagents, a sandbox and scheduled tasks, message, event and component models, plugin config with decorators, lifecycle and hooks, platform adapter interfaces, storage and utilities. A second skill, `docs4agent`, sets rules for writing documentation for agents: remove politeness and explanations of the obvious, compress API examples into one-line `python` blocks and structure text so method names, parameters and types are easy to find. The docs are in Chinese with an `en/` branch.

Who it is for. Developers of AstrBot plugins who build them with an AI agent and want it to know the framework API and rules.

Good fit when

  • You need an AstrBot plugin that reacts to a message or a command with parameters
  • You need to attach a platform adapter and understand its interface
  • The agent needs an exact reference on events, message chains and hooks
  • The plugin needs persistent storage, configuration and a lifecycle
  • API docs should be rewritten in an agent-friendly format

Not a fit when

  • You write for something other than AstrBot: the skill holds only its documentation
  • You need current official docs: the repo is only a synced archive for study
  • You need a ready plugin: the repo holds only a reference

Example request

Read skill-astrbot-dev and write an AstrBot plugin that answers a /hello command with a parameter by greeting the name.

Limitations

The repo calls itself a synced archive of AstrBot docs meant for study, and it has no license file. Current information lives in the official docs at `docs.astrbot.app` and in the main AstrBot repo, so trust them when they differ. The main text is in Chinese, and the `en/` branch is incomplete. The skill does not run AstrBot itself and only suggests plugin code and structure. Installation goes through the skills CLI.

How to disable. Remove the skill with `npx skills remove` or delete the skill folder from the agent skills directory. AstrBot itself and your plugins are not affected.

FAQ

How do I install the skill?

With `npx skills add xunxiing/AstrBot-Skill` for a project or `npx skills add -g xunxiing/AstrBot-Skill` for all projects.

What is AstrBot?

A chatbot framework with a plugin system and platform adapters. The project docs are at `docs.astrbot.app`.

What do the docs cover?

Design standards, the agent system, message and event models, plugin config with decorators and hooks, platform adapters, storage and utilities.

What is docs4agent for?

It teaches writing technical docs for agents: no politeness, one-line `python` examples and a structure for fast method lookup.

Does the repo replace the official docs?

No. It is an archive for study, and fresh information comes from `docs.astrbot.app` and the main AstrBot repo.

Discussion

No questions or reviews yet.

Skills

A library of 30-plus instruction skills for coding agents: planning, building, testing, hallucination guards and shipping

SkillMinimal access217Repository stars

Softaworks Agent Toolkit

Softaworks Agent Skills

A marketplace of skills, subagents and commands for coding agents: development, documentation, planning and workplace communication

PluginExtended access2.7KRepository stars

Builder Skills

Skills for agents

A set of small skills from Builder.io for agent work habits: visual plans and diff recaps, docs-first checks, cross-agent review and clean status updates

SkillExtended access4.7KRepository stars

15 skills for Claude Code and Codex: Laravel, Docker, UI, debugging, tests and docs in four ready plugin bundles

PluginExtended access69Repository stars

A set of independent skills against drift in large codebases: hard-cut, root-cause tracing, lean testing and CI right-sizing.

SkillMinimal access140Repository stars

README in short

Covers the skill purpose, install through the skills CLI or by downloading the file, the docs structure, the second skill docs4agent and links to the AstrBot project.

README badge

Original SKILL.md

---
name: docs4agent
description: 遵循极简主义、代码优先、AI 友好的技术文档写作规范。
---
# docs4agent (文档写作规范)

当需要为 AI Agent 编写或优化技术文档(尤其是 AstrBot 插件 API)时,使用此 Skill。目标是创建 100% 准确、无废话、机器易读的代码字典。

## 写作核心原则

1. **极简主义**:删除所有客套话、目的说明、意义介绍和人类常识。
2. **代码优先**:将 API 示例压缩为单行代码块,并标注 `python` 语言标识。
3. **AI 友好**:使用结构化的标题和列表,确保 AI 能快速定位方法名、参数和类型。
4. **排除常识**:不需要解释“为什么要这样做”,只需告知“怎么做”。
5. 插件开发可直接调用,需要给出全部的插件可以使用的方法
6. 可以去参考sdk(例如astrbot sdk)

## 文档结构模版

### 1. 标题与摘要

标题采用 `# 功能名`,摘要仅保留一行功能描述。

### 2. API 调用区

使用 `###` 级标题区分方法,代码块必须单行化。
示例:
`await manager.method_name(param1="value", param2=True)`

### 3. 维护/工具列表

使用无序列表描述辅助方法:

- `method(id)`: 描述。

### 4. 关键注意事项 (可选)

仅保留不符合常规逻辑或容易导致程序崩溃的底层细节(如 Handler 绑定丢失)。

## 示例 (Cron API)

# Cron #英文后面不需要加一个小括号解释中文

用于定时执行逻辑或唤醒 AI。AI 任务触发生成 `CronMessageEvent`。

## 插件开发 API

通过 `self.context.cron_manager` 调用:

### 1. 注册 Python 函数 (Basic Job)

Report a problem