Cb Realtime API
BlkLeg/CircuitBreaker
How Circuit Breaker moves data between backend and frontend — the NATS internal bus, Redis pub/sub, the WebSocket stream endpoints and their first-message JWT handshake, SSE log/event streams, and…
API design patterns and conventions for this project. An agent skill from huangjia2019/claude-code-engineering.
Install API Conventions
$ npx skills add huangjia2019/claude-code-engineering --skill api-conventions -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install huangjia2019/claude-code-engineering api-conventions --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git skills-src && mkdir -p .claude/skills && cp -r skills-src/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions .claude/skills/api-conventions && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "api-conventions" agent skill from https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions into .claude/skills/api-conventions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-conventions", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/01-reference-skill/.claude/skills/api-conventionsType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add huangjia2019/claude-code-engineering --skill api-conventions -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install huangjia2019/claude-code-engineering api-conventions --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git skills-src && mkdir -p .agents/skills && cp -r skills-src/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions .agents/skills/api-conventions && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "api-conventions" agent skill from https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions into .agents/skills/api-conventions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-conventions", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add huangjia2019/claude-code-engineering --skill api-conventions -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install huangjia2019/claude-code-engineering api-conventions --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions .cursor/skills/api-conventions && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "api-conventions" agent skill from https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions into .cursor/skills/api-conventions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-conventions", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/huangjia2019/claude-code-engineering.git --path 04-Skills/projects/01-reference-skill/.claude/skills/api-conventions--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add huangjia2019/claude-code-engineering --skill api-conventions -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install huangjia2019/claude-code-engineering api-conventions --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions .gemini/skills/api-conventions && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "api-conventions" agent skill from https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions into .gemini/skills/api-conventions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-conventions", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install huangjia2019/claude-code-engineering api-conventionsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add huangjia2019/claude-code-engineering --skill api-conventions -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git skills-src && mkdir -p .github/skills && cp -r skills-src/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions .github/skills/api-conventions && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "api-conventions" agent skill from https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions into .github/skills/api-conventions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-conventions", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add huangjia2019/claude-code-engineering --skill api-conventions -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install huangjia2019/claude-code-engineering api-conventions --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions .opencode/skills/api-conventions && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "api-conventions" agent skill from https://github.com/huangjia2019/claude-code-engineering/tree/main/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions into .opencode/skills/api-conventions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-conventions", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
api-conventions- GitHub stars
- 1.1k
- Token cost
- ~398 tokens
- SKILL.md length
- 134 words
- Files
- 1
- Skills in repo
- 10
- Repo updated
- First seen
- Licence
- None found
At a glance
API design patterns and conventions for this project. An agent skill from huangjia2019/claude-code-engineering.
- Reviewing API endpoints
- SKILL.md covers URL Naming, Response Format, HTTP Status Codes and Authentication, plus 1 more section
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
- Designing new APIs
What it does
API Conventions is an agent skill from huangjia2019/claude-code-engineering. API design patterns and conventions for this project. Covers RESTful URL naming, response format standards, error handling, and authentication requirements. Use when writing or reviewing API endpoints, designing new APIs, or making decisions about request/response formats.
Its SKILL.md is about 400 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Backend & APIs, covering Structured output and tool calling, REST APIs and API design. The repository describes itself as: This repository demonstrates how to use Claude Code to do real engineering work, not just writing code. 本项目是极客时间专栏 《Claude Code 工程化实战》 的官方配套示例仓库，目标就是： 👉 把 Claude Code…
When your agent uses it
- Reviewing API endpoints
- Designing new APIs
- Making decisions about request/response formats
Example prompts
- “/api-conventions”
Requirements
- Pre-approved tools (allowed-tools): Read, Grep, Glob
What it can do on your machine
Read from SKILL.md and the folder at commit 89fea03. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves these tools, so the agent can use them without asking each time:
ReadGrepGlob
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are json).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
API Conventions loads about 398 tokens when it runs. Until then it costs about 72 tokens; SKILL.md has 134 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
Without a licence we can't republish the file, so here is its outline and opening line. It has 134 words (~398 tokens).
“These are the API design standards for our project. Apply these conventions whenever working with API endpoints.”
- name
- api-conventions
- allowed-tools
- Read, Grep, Glob
Files
Just SKILL.md in 04-Skills/projects/01-reference-skill/.claude/skills/api-conventions of huangjia2019/claude-code-engineering.
Open the folder on GitHubat commit 89fea03
Compare with similar skills
API Conventions next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| API Conventions this skillhuangjia2019/claude-code-engineering | 1.1k | — | ~398 | Automated safety check: Pass | None | |
| Cb Realtime APIBlkLeg/CircuitBreaker | 201 | — | ~1.7k | Automated safety check: Pass | MIT | |
| WooCommerce Store API Routeswoocommerce/woocommerce | 11k | — | ~932 | Automated safety check: Pass | Custom licence | |
| Discover APIrand/cc-polymath | 181 | — | ~1.5k | Automated safety check: Pass | MIT | |
| API Designeraiskillstore/marketplace | 430 | — | ~3.6k | Automated safety check: Pass | None | |
| Nodejs Backend Patternsever-works/ever-works | 162 | 18 repos | ~4k | Automated safety check: Pass | AGPL-3.0 |
Similar skills
WooCommerce Store API Routes
woocommerce/woocommerce
Guidelines for adding or changing routes in the WooCommerce Store API under /wc/store/v1, covering authentication, REST design, schemas and variations.
Discover API
rand/cc-polymath
Automatically discover API design skills when working with REST APIs, GraphQL schemas, API authentication, OAuth, JWT, rate limiting, API versioning, error handling, or endpoint design.
API Designer
aiskillstore/marketplace
Design and document RESTful and GraphQL APIs with OpenAPI/Swagger specifications, authentication patterns, versioning strategies, and best practices.
Nodejs Backend Patterns
ever-works/ever-works
Build production-ready Node.js backend services with Express/Fastify, implementing middleware patterns, error handling, authentication, database integration, and API design best practices.
API Designer
Jeffallan/claude-skills
Designs REST and GraphQL APIs from resource modeling to an OpenAPI 3.1 contract, with versioning, pagination and RFC 7807 error handling.
More from huangjia2019/claude-code-engineering
All 10 skills in this repoFinancial Analyzing
huangjia2019/claude-code-engineering
Analyze financial data, calculate financial ratios, and generate analysis reports.
API Documenting
huangjia2019/claude-code-engineering
Generate API documentation from code. An agent skill from huangjia2019/claude-code-engineering.
API Generating
huangjia2019/claude-code-engineering
Generate API endpoint code and documentation from specifications.
API Generating
huangjia2019/claude-code-engineering
Generate API endpoint documentation from Express route files.
Code Health Check
huangjia2019/claude-code-engineering
Perform a comprehensive code health check on a directory. An agent skill from huangjia2019/claude-code-engineering.
Code Reviewing
huangjia2019/claude-code-engineering
Review code for quality, security, and best practices. An agent skill from huangjia2019/claude-code-engineering.
Related
Categories
Questions about API Conventions
What does API Conventions do?
API design patterns and conventions for this project. An agent skill from huangjia2019/claude-code-engineering. API Conventions is an agent skill from huangjia2019/claude-code-engineering. API design patterns and conventions for this project.
When should I use API Conventions?
API Conventions fits situations like: reviewing API endpoints; designing new APIs; making decisions about request/response formats.
How do I install API Conventions in Claude Code?
Run `npx skills add huangjia2019/claude-code-engineering --skill api-conventions -a claude-code`. Or copy the skill folder (04-Skills/projects/01-reference-skill/.claude/skills/api-conventions in huangjia2019/claude-code-engineering) into .claude/skills/api-conventions in your project. Claude Code loads it when a task matches its description.
How do I install API Conventions in Codex?
Run `npx skills add huangjia2019/claude-code-engineering --skill api-conventions -a codex`. Or copy the skill folder (04-Skills/projects/01-reference-skill/.claude/skills/api-conventions in huangjia2019/claude-code-engineering) into .agents/skills/api-conventions in your project. Codex loads it when a task matches its description.
Can I use API Conventions in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add huangjia2019/claude-code-engineering --skill api-conventions -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-conventions, .gemini/skills/api-conventions, .github/skills/api-conventions and .opencode/skills/api-conventions in your project.
What does API Conventions need to run?
SKILL.md names no scripts, command-line tools or credentials: API Conventions is instructions for the agent only. Its frontmatter pre-approves these tools: Read, Grep, Glob.
Does API Conventions access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is API Conventions safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does API Conventions use?
No licence was found for API Conventions or its repository. Without one, default copyright applies: ask the author before reusing or redistributing it.
How many tokens does API Conventions use?
About 398 tokens (SKILL.md is roughly 1.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to API Conventions?
Skills that share tags, products or a category with API Conventions: Cb Realtime API (BlkLeg/CircuitBreaker, 201 stars), WooCommerce Store API Routes (woocommerce/woocommerce, 11k stars), Discover API (rand/cc-polymath, 181 stars) and API Designer (aiskillstore/marketplace, 430 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains API Conventions?
huangjia2019 (a GitHub user) maintains it in huangjia2019/claude-code-engineering, which has 1,133 GitHub stars. The repository holds 10 skills in this directory. The repository was last updated on July 23, 2026.
Source: huangjia2019/claude-code-engineering on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.