project-structure

An overview of the structure and main parts of Koapp, a Node.js web framework built on Koa.js. It describes its HTTP, TCP socket, and WebSocket application types, along with routers, controllers, models, middleware, tests, and templates.

In plain words
What is it for?
Use it when navigating the project, choosing between HTTP, TCP socket, and WebSocket servers, locating framework components, or understanding how the CLI and project templates are organized.
Why use it?
It helps new contributors find the right part of the framework and understand how its application types relate. It also explains where source code, commands, templates, and tests are kept.

Cursor rule for Codex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/axiosleo/node-koapp/project-structure
Clone the repo
git clone --depth 1 https://github.com/AxiosLeo/node-koapp

Made for: Codex.

Per session 307 This file is loaded in full into every session.
When invoked 307 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00307 $0.00307
Opus 5 $0.00153 $0.00153
Sonnet 5 $0.00061 $0.00061
Haiku 4.5 $0.00031 $0.00031

Measured yesterday against content hash 070fd07e74e6, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

project-structure scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.agents/rules/project-structure.mdc · 37 lines

What it actually says

@axiosleo/koapp Project Structure

This is a Node.js web framework built on Koa.js for rapid application development.

Core Architecture

The main entry point is index.js, which exports all framework components:

  • Applications: KoaApplication, SocketApplication, WebSocketApplication
  • Core Classes: Router, Controller, Model
  • Utilities: Response helpers, middlewares, context initialization

Key Directories

  • src/ - Framework source code
    • apps/ - Application types (Koa, Socket, WebSocket)
    • workflows/ - Request processing workflows
    • middlewares/ - Custom middleware implementations
  • assets/ - Templates and static assets
    • tmpl/ - Project scaffolding templates
  • commands/ - CLI command implementations
  • tests/ - Test files and examples
  • bin/ - Executable CLI entry point

Application Types

  1. KoaApplication - Standard HTTP web server (extends Application)
  2. SocketApplication - TCP socket server (extends Application)
  3. WebSocketApplication - Native WebSocket server (extends SocketApplication)

KoaApplication and SocketApplication extend the base Application class. WebSocketApplication extends SocketApplication, inheriting connection management methods.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 37 lines · 307 tokens per session scan A 070fd07e74e6

Subscribe to this mod's changes

project-structure is a cursor rule published in the GitHub repository AxiosLeo/node-koapp (129 stars, last pushed 18d ago), licensed MIT. It adds 307 tokens to every session, about $0.0015 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.