# Send yapi to your agent
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
## Fast path
- Download the package from Yavira.
- Extract it into a folder your agent can access.
- Paste one of the prompts below and point your agent at the extracted folder.
## Suggested prompts
### New install

```text
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete.
```
### Upgrade existing

```text
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run.
```
## Machine-readable fields
```json
{
  "schemaVersion": "1.0",
  "item": {
    "slug": "yapi",
    "name": "yapi",
    "source": "tencent",
    "type": "skill",
    "category": "效率提升",
    "sourceUrl": "https://clawhub.ai/leeguooooo/yapi",
    "canonicalUrl": "https://clawhub.ai/leeguooooo/yapi",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadUrl": "/downloads/yapi",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=yapi",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "packageFormat": "ZIP package",
    "primaryDoc": "SKILL.md",
    "includedAssets": [
      "SKILL.md"
    ],
    "downloadMode": "redirect",
    "sourceHealth": {
      "source": "tencent",
      "slug": "yapi",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-05-01T23:39:13.981Z",
      "expiresAt": "2026-05-08T23:39:13.981Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=yapi",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=yapi",
        "contentDisposition": "attachment; filename=\"yapi-1.0.1.zip\"",
        "redirectLocation": null,
        "bodySnippet": null,
        "slug": "yapi"
      },
      "scope": "item",
      "summary": "Item download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this item.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/yapi"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    }
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/yapi",
    "downloadUrl": "https://openagent3.xyz/downloads/yapi",
    "agentUrl": "https://openagent3.xyz/skills/yapi/agent",
    "manifestUrl": "https://openagent3.xyz/skills/yapi/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/yapi/agent.md"
  }
}
```
## Documentation

### Command policy

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

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

In command examples below, yapi can be replaced by npx -y @leeguoo/yapi-mcp.

### Quick workflow

If user gives a YApi URL, verify it belongs to configured base_url.
Confirm auth (yapi whoami), then run yapi login only when needed.
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.

### URL detection

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

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:

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

### Common commands

# version/help
yapi --version
yapi -h

# auth
yapi whoami
yapi login

# 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

Config cache locations:

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

### Docs sync

Binding mode (recommended):

yapi docs-sync bind add --name projectA --dir docs/release-notes --project-id 267 --catid 3667
yapi docs-sync --binding projectA --dry-run
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
Default behavior syncs changed files only; use --force for full sync.
Compatible with directory .yapi.json config as fallback (without binding).
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.
## Trust
- Source: tencent
- Verification: Indexed source record
- Publisher: leeguooooo
- Version: 1.0.1
## Source health
- Status: healthy
- Item download looks usable.
- Yavira can redirect you to the upstream package for this item.
- Health scope: item
- Reason: direct_download_ok
- Checked at: 2026-05-01T23:39:13.981Z
- Expires at: 2026-05-08T23:39:13.981Z
- Recommended action: Download for OpenClaw
## Links
- [Detail page](https://openagent3.xyz/skills/yapi)
- [Send to Agent page](https://openagent3.xyz/skills/yapi/agent)
- [JSON manifest](https://openagent3.xyz/skills/yapi/agent.json)
- [Markdown brief](https://openagent3.xyz/skills/yapi/agent.md)
- [Download page](https://openagent3.xyz/downloads/yapi)