| name | agent-native-docs |
| description | How to look up version-matched Agent Native framework docs and source in node_modules. Use before coding against @agent-native/core APIs or advanced features. |
Agent Native Docs Lookup
Rule
Before implementing non-trivial Agent Native functionality, read the
version-matched docs installed with @agent-native/core. When implementation
examples or template patterns matter, inspect the packaged source corpus too.
How
- Start from the generated app root.
- Start cross-corpus discovery with
pnpm action framework-search --pattern "<feature>".
- Use
--scope docs or --scope source and --mode glob, --mode sql-like,
or --mode regex when the question needs a narrower pattern.
- Read a specific page with
pnpm action docs-search --slug <slug>.
- Search source examples with
pnpm action source-search --query "<pattern>"
or read a file with pnpm action source-search --path <path>.
- If the action runner is unavailable, search
node_modules/@agent-native/core/docs directly with rg.
Search node_modules/@agent-native/core/corpus for source examples.
- For app-specific rules, also read the app's own
AGENTS.md and any relevant
.agents/skills/<name>/SKILL.md.
Useful Slugs
| Need | Slugs |
|---|
| Actions and typed client calls | actions, client |
| SQL, auth, access, sharing | database, authentication, security, sharing |
| UI state visible to the agent | context-awareness |
| Headless and chat-first apps | pure-agent-apps, agent-surfaces, using-your-agent |
| Automations and schedules | automations, recurring-jobs |
| Cross-app and external agents | a2a-protocol, external-agents, mcp-protocol, mcp-apps |
| Skills and instructions | skills-guide, writing-agent-instructions |
Don't
- Do not rely on memory for framework APIs when local package docs are present.
- Do not add custom REST wrappers for normal app data before reading
actions.
- Do not add inline LLM calls before reading
using-your-agent and
agent-surfaces.
