Skill

yapi

Query YApi interfaces and run docs-sync workflows through the local yapi CLI. Use when the user mentions YApi, shares a YApi URL, or asks for docs-sync operations.

Install

npx claudepluginhub port-wind/marketplace --plugin yapi-plugin

Tool Access

This skill uses the workspace's default tool permissions.

SKILL.md

Similar Skills

executing-plans

Executes pre-written implementation plans: critically reviews, follows bite-sized steps exactly, runs verifications, tracks progress with checkpoints, uses git worktrees, stops on blockers.

superpowers

144.6k

dispatching-parallel-agents

Dispatches parallel agents to independently tackle 2+ tasks like separate test failures or subsystems without shared state or dependencies.

superpowers

144.6k

brainstorming

7 files

Guides idea refinement into designs: explores context, asks questions one-by-one, proposes approaches, presents sections for approval, writes/review specs before coding.

superpowers

144.6k

Stats

Stars0

Forks0

Last CommitMar 31, 2026

Actions

View Source View Plugin View on GitHub View README

YApi Skill

Use this skill when the task is clearly about YApi.

Preferred execution path

Do not call plugin-local node scripts/... files from the user's project. In Cursor, commands run from the user's current workspace, so relative plugin paths are unreliable.

Always use the real yapi CLI directly:

Check whether yapi exists with command -v yapi.
If yapi is missing and the user wants setup, install @leeguoo/yapi-mcp with npm install -g @leeguoo/yapi-mcp.
If the CLI reports skill update available, rerun yapi install-skill --force.
Use direct yapi ... commands for query and docs-sync operations.
Only ask the user to run yapi login when whoami or another command shows a login/config problem.

What the plugin assumes

node and npm are installed locally
The plugin may install @leeguoo/yapi-mcp globally if yapi is missing
Authentication is reused from ~/.yapi/config.toml

Supported workflows

Setup and login

Verify YApi CLI availability with command -v yapi
If missing, install with npm install -g @leeguoo/yapi-mcp
Upgrade with yapi self-update when the user explicitly wants the latest CLI
Check login state with yapi whoami
If login is missing, guide the user to run yapi login
Do not invent a second config format; always reuse ~/.yapi/config.toml

Query interfaces

Search interfaces: yapi search --q <keyword>
Query by ID: yapi --path /api/interface/get --query id=<api_id>
List category interfaces: yapi --path /api/interface/list_cat --query catid=<catid>
Combined query string is supported: yapi --path /api/interface/list_cat --query "catid=4631&limit=50&page=1"
Inspect login state: yapi whoami

Docs sync

Bind docs: yapi docs-sync bind add --name <binding> --dir <path> --project-id <id> --catid <id>
In global ~/.yapi/docs-sync.json mode, relative --dir values are resolved from the current git project root
Preview first: yapi docs-sync --binding <binding> --dry-run
Run sync: yapi docs-sync --binding <binding>

URL detection

When the user shares a YApi URL:

Read ~/.yapi/config.toml and compare the URL origin with base_url
If the origin matches, extract:
- project_id from /project/<id>/...
- api_id from /interface/api/<id>
- catid from /interface/api/cat_<id>
Use the matching CLI command instead of manual browser steps

Response expectations

Summarize method, path, headers, request schema, and response schema when interface data is returned
If a direct CLI command fails, surface the stderr and suggest the next step
Do not instruct the model to run plugin-relative files from the current workspace