YApi interface docs

Install / update

Preferred install / refresh flow:

bash

npx skills add leeguooooo/cross-request-master -y -g

Preferred config bootstrap after skill install:

bash

yapi config init --base-url=https://your-yapi-domain.com --auth-mode=global --email=YOUR_EMAIL
yapi login --base-url=https://your-yapi-domain.com --browser

Compatibility path when the user also wants to write

~/.yapi/config.toml

in one step:

bash

npm install -g @leeguoo/yapi-mcp
yapi install-skill --yapi-base-url=https://your-yapi-domain.com --yapi-auth-mode=global --yapi-email=YOUR_EMAIL --force

Command policy

Prefer

yapi

command. If missing, fallback to one-shot npx without forcing global install:

bash

yapi -h
# fallback:
npx -y -p @leeguoo/yapi-mcp yapi -h

In command examples below,

yapi

can be replaced by

npx -y -p @leeguoo/yapi-mcp yapi

. When CLI version is newer than the installed skill snapshot,

yapi

warns and asks to rerun:

bash

npx skills add leeguooooo/cross-request-master -y -g
# compatibility:
npx -y -p @leeguoo/yapi-mcp yapi install-skill --force

Setup / auth bootstrap

Read configured
```
base_url
```
from
```
~/.yapi/config.toml
```
when available.
If config is missing, prefer browser login bootstrap:

bash

yapi login --base-url https://your-yapi-domain.com --browser
# optional explicit page:
yapi login --base-url https://your-yapi-domain.com --login-url https://your-yapi-domain.com/

If the user provides email/password, global auth also works:

bash

yapi login --base-url https://your-yapi-domain.com --email you@example.com --password '***'

Validate login before deeper operations:

bash

yapi whoami

Quick workflow

If user gives a YApi URL, verify it belongs to configured
```
base_url
```
.
Confirm auth (
```
yapi whoami
```
), then run
```
yapi login --browser
```
when needed (open base URL, finish login in browser, then press Enter to sync cookie).
Resolve target by
```
api_id
```
/ keyword / category.
Fetch raw JSON first, then summarize: method, path, headers, params, body, response schema/examples.
For docs sync tasks, do
```
--dry-run
```
first, then real sync.
If docs sync still hits
```
413
```
, note that CLI already retries the file with
```
--mermaid-classic
```
; if it still fails, split the doc or reduce embedded diagrams.

URL detection

Read configured
```
base_url
```
from
```
~/.yapi/config.toml
```
.

bash

rg -n "^base_url\\s*=" ~/.yapi/config.toml

If URL origin matches

base_url

, extract IDs from path:

```
/project/123/...
```
->
```
project_id=123
```
```
.../api/456
```
->
```
api_id=456
```
```
.../api/cat_789
```
->
```
catid=789
```

Prefer direct lookup when
```
api_id
```
exists:

bash

yapi --path /api/interface/get --query id=<api_id>

Common commands

bash

# version/help
yapi --version
yapi self-update
yapi -h

# auth
yapi whoami
yapi login --base-url https://your-yapi-domain.com --browser
yapi login --browser
yapi login --login-url https://your-yapi-domain.com/
yapi logout

# search / fetch
yapi search --q keyword --project-id 310
yapi --path /api/interface/get --query id=123
yapi --path /api/interface/list_cat --query catid=123
yapi --path /api/interface/list_cat --query "catid=4631&limit=50&page=1"

# browse entities
yapi group list
yapi project list --group-id 129 --page 1 --limit 10
yapi project get --id 365
yapi project token --project-id 365
yapi interface list-menu --project-id 365
yapi interface list --project-id 365 --limit all
yapi interface get --id 31400
yapi interface cat add --project-id 365 --name "公共分类" --desc ""
yapi interface cat update --cat-id 3722 --name "公共分类 1" --desc "公共分类"
yapi interface cat delete --cat-id 4169
yapi env --project-id 365
yapi member list --project-id 365
yapi follow
yapi user search --q keyword
yapi log list --type group --type-id 129 --page 1 --limit 10

# exports / test collections
yapi export --project-id 365 --type swagger --name openapi.json
yapi col list --project-id 365
yapi col cases --id 12 --project-id 365

Config cache locations:

Config:
```
~/.yapi/config.toml
```
Auth cache:
```
~/.yapi-mcp/auth-*.json
```

Browser login dependency:

bash

agent-browser-stealth -V
# install once if missing browser runtime
agent-browser-stealth install

Docs sync

Binding mode (recommended):

bash

yapi docs-sync bind add --name projectA --dir docs/release-notes --project-id 267 --catid 3667
yapi docs-sync bind list
yapi docs-sync bind get --name projectA
yapi docs-sync bind update --name projectA --source-file architecture.md
yapi docs-sync --binding projectA --dry-run
yapi docs-sync --binding projectA --source-file architecture.md
yapi docs-sync --binding projectA

Notes:

Binding file:
```
.yapi/docs-sync.json
```

Mapping outputs:

.yapi/docs-sync.links.json

.yapi/docs-sync.projects.json

.yapi/docs-sync.deployments.json

When bindings live under the global
```
~/.yapi/docs-sync.json
```
, relative
```
--dir
```
values are resolved from the current git project root and stored as
```
$HOME
```
-relative paths.
Default behavior syncs changed files only; use
```
--force
```
for full sync.
Compatible with directory
```
.yapi.json
```
config as fallback (without binding).

yapi docs-sync bind remove --name projectA

removes a binding.

```
--source-file
```
overrides binding
```
source_files
```
;
```
--clear-source-files
```
clears the stored list on bind update.
```
--dry-run
```
prints per-file preview lines with Markdown/HTML/payload sizes before upload.
If upload hits
```
413 Payload Too Large
```
, the CLI first retries that file with
```
--mermaid-classic
```
, then reports payload size, parsed server limit (when available), and the largest Mermaid block if it still fails.
Mermaid/PlantUML/Graphviz/D2 rendering depends on local tool availability; missing tools do not block basic sync.

Interface creation guardrails

Always set
```
req_body_type
```
(use
```
json
```
if unsure) and provide
```
res_body
```
(prefer JSON Schema) when creating/updating interfaces.
Put structured request/response fields in
```
req_*
```
/
```
res_body
```
, not only in free-text
```
desc
```
/
```
markdown
```
.

yapi

NPX Install

Tags

SKILL.md Content

YApi interface docs

Install / update

Command policy

Setup / auth bootstrap

Quick workflow

URL detection

Common commands

Docs sync

Interface creation guardrails