菜单
Provides guidance on working with the Zhin chatbot framework, including bot creation, plugin development, and integration with various chat platforms. Use when users ask about Zhin framework, bot development, or chat platform integration.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Explains Zhin command registration, middleware flow, and permission checks. Use when building commands or message middleware in Zhin plugins.
Guides creation and management of Zhin tools using ZhinTool, defineTool, and ToolService. Covers the unified tool system that bridges AI agent tool-calling and message commands, including Tool↔Command conversion, permission levels, platform/scope filtering, and tool collection. Use when registering tools, converting between tools and commands, or integrating tools with AI agents.
Guides integration of AI/LLM capabilities in Zhin plugins using @zhin.js/ai. Covers multi-model providers, Agent tool calling, session management, streaming responses, unified tool services, and rich media output. Use when adding AI chat, agents, or tool-calling features to a Zhin bot.
Guides development of custom platform adapters in Zhin. Covers extending the Adapter abstract class, creating Bot instances, handling message events, registering tools, and lifecycle management. Use when building adapters for new chat platforms.
Guides database usage in Zhin including model definitions, CRUD queries, transactions, migrations, and lifecycle hooks. Covers the built-in ORM based on @zhin.js/database with SQLite support. Use when working with data persistence in Zhin plugins.
Guides error handling in Zhin using the built-in error hierarchy, ErrorManager, RetryManager, and CircuitBreaker. Use when implementing resilient error handling, retry logic, or circuit breaker patterns in Zhin plugins.
| name | zhin-helper |
| description | Provides guidance on working with the Zhin chatbot framework, including bot creation, plugin development, and integration with various chat platforms. Use when users ask about Zhin framework, bot development, or chat platform integration. |
| license | MIT |
| metadata | {"author":"zhinjs","version":"1.0","framework":"zhin"} |
This skill provides comprehensive guidance for working with the Zhin chatbot framework.
Zhin is a powerful, flexible chatbot framework for Node.js that supports multiple chat platforms including:
To create a new Zhin bot:
npm init zhin-bot my-bot
cd my-bot
npm install
npm start
Zhin uses a plugin-based architecture. A basic plugin structure:
import { Plugin } from 'zhin';
export default class MyPlugin extends Plugin {
constructor(ctx) {
super(ctx);
}
async install() {
// Plugin initialization logic
}
async uninstall() {
// Cleanup logic
}
}
Handle messages using middleware pattern:
bot.middleware((session, next) => {
// Process message
if (session.content === 'hello') {
return session.reply('Hi there!');
}
return next();
});
Register commands for bot interaction:
bot.command('ping')
.action((session) => {
return session.reply('Pong!');
});
Each platform requires specific configuration:
bot.adapter('icqq', {
uin: 'YOUR_QQ_NUMBER',
password: 'YOUR_PASSWORD'
});
bot.adapter('discord', {
token: 'YOUR_BOT_TOKEN'
});
npm install [package-name]
npm run dev
npm run build
Use this skill when: