Documentation Index

Fetch the complete documentation index at: https://redop.useagents.site/docs/llms.txt

Use this file to discover all available pages before exploring further.

​

Agent Skills

AI-ready Redop knowledge for assistants that need to explain, design, debug, and build MCP servers with Redop.

​

What are Agent Skills?

• Framework knowledge: core Redop concepts, lifecycle, transports, and composition patterns
• Design guidance: when to use tools, resources, prompts, middleware, hooks, modules, and plugins
• Implementation help: examples and prompts for building or debugging a Redop server

​

Available Skill

​

Installing the Skill

bunx skills add redopjs/skills

​

What the Skill Does

​

Framework Explanation

• what Redop is and when it is a good fit
• the Redop mental model and explicit composition style
• how tools, resources, and prompts differ
• how the request lifecycle works from derive through afterResponse

​

Design Guidance

• when to model something as a tool vs a resource vs a prompt
• when to use middleware vs hooks
• when to use .use(...) with feature modules vs extracting a plugin
• when to scaffold with create-redop-app vs install @redopjs/redop directly

​

Build and Debug Help

• building a first Redop server
• adding typed input with Zod and other supported schema styles
• choosing HTTP vs stdio transport
• understanding plugin-based typed request context
• debugging transport, lifecycle, and error-handling questions

​

Example Prompts

​

Skill Structure

skills/
└── redop/
    ├── SKILL.md
    ├── agents/
    │   └── openai.yaml
    └── references/
        ├── foundations.md
        ├── surfaces.md
        ├── runtime.md
        ├── composition.md
        ├── transports.md
        ├── scaffolding.md
        └── examples.md

​

Reference Documents

​

foundations.md

• what Redop is
• the core mental model
• when to choose Redop
• constructor and request-context basics

​

surfaces.md

• tool, resource, and prompt design
• schema usage
• annotations
• handler contracts

​

runtime.md

• request execution order
• middleware and hooks
• error behavior
• after-response work

​

composition.md

• feature modules
• plugins
• typed context propagation
• built-in auth and logging helpers

​

transports.md

• listen() shapes
• HTTP vs stdio
• /mcp
• session behavior and transport caveats

​

scaffolding.md

• create-redop-app
• install-vs-scaffold decisions
• starter defaults
• transport, schema, and deploy choices

​

examples.md

• portable example patterns
• optional deep-dive pointers when a Redop checkout is available

​

Next Steps

• Installation
• Create a Project with create-redop-app
• Your First Server
• Tools
• Plugins

• Agent Skills Spec