OpenParable
Skip to content
← Back to skills

Midway

Development
midway

Midway 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.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
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

  1. Resolve the user's requested version first. Run npm exec midway-skill -- resolve-version <version> or pnpm exec midway-skill resolve-version <version>. If no version is given, use current.

  2. Query the right source for the question. Use npm exec midway-skill -- lookup-docs --query "<topic>" or pnpm exec midway-skill lookup-docs --query "<topic>". Use npm exec midway-skill -- lookup-api --symbol "<symbol>" or pnpm exec midway-skill lookup-api --symbol "<symbol>" for current-major API lookups. Use npm exec midway-skill -- lookup-packages --query "<package or feature>" or pnpm exec midway-skill lookup-packages --query "<package or feature>". Use npm exec midway-skill -- lookup-changelog --package "<package>" or pnpm exec midway-skill lookup-changelog --package "<package>" for release history.

  3. 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 docs and changelog.
  • If resolve-version reports api: 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.