Skip to content

zeromicro/zero-skills

Repository files navigation

go-zero Skills for AI Agents

English | 简体中文

This is an Agent Skill containing structured knowledge and patterns for AI coding assistants to help developers work effectively with the go-zero framework.

What is a Skill?

Skills are folders of instructions, scripts, and resources that AI agents discover and load dynamically to perform better at specific tasks. This skill teaches AI agents how to generate production-ready go-zero microservices code.

Purpose

This skill enables AI agents (Claude, GitHub Copilot, Cursor, etc.) to:

  • Generate accurate go-zero code following framework conventions
  • Understand the three-layer architecture (Handler → Logic → Model)
  • Apply best practices for microservices development
  • Troubleshoot common issues efficiently
  • Build production-ready applications

Agent Skill Structure

Following the Agent Skills Spec:

zero-skills/
├── SKILL.md                    # Entry point with YAML frontmatter
├── getting-started/            # Quick start guides
├── references/                 # Detailed pattern documentation
│   ├── rest-api-patterns.md    # REST API development patterns
│   ├── rpc-patterns.md         # gRPC service patterns
│   ├── database-patterns.md    # Database operations
│   └── resilience-patterns.md  # Resilience and fault tolerance
├── best-practices/             # Production recommendations
├── troubleshooting/            # Common issues and solutions
├── articles/                   # In-depth guides
└── examples/                   # Demo projects and verification scripts

Using This Skill

With Claude Desktop/Code

This skill works automatically when loaded into Claude. See SKILL.md for the complete guide.

With Other AI Assistants

Reference the skill in your AI context:

  1. For GitHub Copilot: Use ai-context which links to this skill
  2. For Cursor/Windsurf: Add as project rules (see AI Ecosystem Guide)
  3. For API usage: Include relevant pattern files from references/ in your prompts

Integration with go-zero AI Ecosystem

zero-skills is part of the go-zero AI tools ecosystem:

  • ai-context - Concise instructions for GitHub Copilot
  • zero-skills (this repo) - Detailed knowledge base for all AI assistants
  • mcp-zero - Runtime tools for Claude Desktop

See AI Ecosystem Guide for details.

Contributing

Contributions are welcome! Please ensure:

  • Examples are complete and tested
  • Patterns follow official go-zero conventions
  • Content is structured for AI consumption
  • Include both correct and incorrect examples

License

MIT License - Same as go-zero framework

About

AI-optimized knowledge base for building applications with go-zero

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published