Yao Doc
Documentsyao-docYao Doc is an Agent Skill for documents published in the YaoApp/yao repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Yao process documentation expert. ALWAYS invoke this skill when the user needs to discover available processes, read process signatures, or validate process names. Do not guess process APIs — use this skill first.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/YaoApp/yao/blob/HEAD/tools/skills/yao-doc/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/yao-doc, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Documentation Tools
Three tools for browsing Yao process documentation, called via bash.
doc_list
Search and list available process documentation entries.
tai tool doc_list '{"keyword": "user", "limit": 10}'
| Parameter | Type | Required | Description |
|---|---|---|---|
keyword | string | no | Search keyword (empty to list all) |
limit | integer | no | Max results (default 20) |
doc_inspect
Get detailed documentation for a specific process: arguments, return type, methods.
tai tool doc_inspect '{"name": "models.user.Find"}'
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Process name (e.g. models.user.Find) |
doc_validate
Check if a process name is valid. Returns suggestions for similar processes if not found.
tai tool doc_validate '{"name": "models.user.Findd"}'
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Process name to validate |
Workflow
- doc_list — discover available processes by keyword
- doc_inspect — read the full signature before calling
- doc_validate — fix typos when a process name doesn't work
Guidelines
- Always use doc_inspect before calling an unfamiliar process via process_call
- Use doc_validate when you get unexpected errors — the name might be misspelled