Midway
DevelopmentmidwayMidway is an Agent Skill for development published in the midwayjs/midway repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Use when the task involves Midway framework docs, package selection, API lookup, version compatibility, MCP/HTTP/framework components, or migration guidance. Resolve the requested Midway version first, then query the local Midway skill bundle with `midway-skill` commands.
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/midwayjs/midway/blob/HEAD/packages/skill-midway/skills/midway/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/midway, 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.
Midway
Use the local @midwayjs/skill-midway bundle before relying on memory.
Workflow
-
Resolve the user's requested version first. Run
npm exec midway-skill -- resolve-version <version>orpnpm exec midway-skill resolve-version <version>. If no version is given, usecurrent. -
Query the right source for the question. Use
npm exec midway-skill -- lookup-docs --query "<topic>"orpnpm exec midway-skill lookup-docs --query "<topic>". Usenpm exec midway-skill -- lookup-api --symbol "<symbol>"orpnpm exec midway-skill lookup-api --symbol "<symbol>"for current-major API lookups. Usenpm exec midway-skill -- lookup-packages --query "<package or feature>"orpnpm exec midway-skill lookup-packages --query "<package or feature>". Usenpm exec midway-skill -- lookup-changelog --package "<package>"orpnpm exec midway-skill lookup-changelog --package "<package>"for release history. -
Cite what the bundle resolved. Include the requested version, resolved version, and whether it was an exact match or major-version fallback.
Rules
- Prefer bundle results over recollection.
- Historical majors only guarantee
docsandchangelog. - If
resolve-versionreportsapi: false, do not claim exact historical API details. - When results are empty, say that the bundle did not contain a match instead of inventing one.
- Prefer package names with the
@midwayjs/scope in answers when known.
Output
- State the resolved Midway version.
- Summarize the matched docs/API/package/changelog result.
- Keep links or source paths from bundle records when relevant.