AGENTS.md

1# MCP "Everything" Server - Development Guidelines
2 
3## Build, Test & Run Commands
4 
5- Build: `npm run build` - Compiles TypeScript to JavaScript
6- Watch mode: `npm run watch` - Watches for changes and rebuilds automatically
7- Run STDIO server: `npm run start:stdio` - Starts the MCP server using stdio transport
8- Run SSE server: `npm run start:sse` - Starts the MCP server with SSE transport
9- Run StreamableHttp server: `npm run start:streamableHttp` - Starts the MCP server with StreamableHttp transport
10- Prepare release: `npm run prepare` - Builds the project for publishing
11 
12## Code Style Guidelines
13 
14- Use ES modules with `.js` extension in import paths
15- Strictly type all functions and variables with TypeScript
16- Follow zod schema patterns for tool input validation
17- Prefer async/await over callbacks and Promise chains
18- Place all imports at top of file, grouped by external then internal
19- Use descriptive variable names that clearly indicate purpose
20- Implement proper cleanup for timers and resources in server shutdown
21- Handle errors with try/catch blocks and provide clear error messages
22- Use consistent indentation (2 spaces) and trailing commas in multi-line objects
23- Match existing code style, import order, and module layout in the respective folder.
24- Use camelCase for variables/functions,
25- Use PascalCase for types/classes,
26- Use UPPER_CASE for constants
27- Use kebab-case for file names and registered tools, prompts, and resources.
28- Use verbs for tool names, e.g., `get-annotated-message` instead of `annotated-message`
29 
30## Extending the Server
31 
32The Everything Server is designed to be extended at well-defined points.
33See [Extension Points](docs/extension.md) and [Project Structure](docs/structure.md).
34The server factory is `src/everything/server/index.ts` and registers all features during startup as well as handling post-connection setup.
35 
36### High-level
37 
38- Tools live under `src/everything/tools/` and are registered via `registerTools(server)`.
39- Resources live under `src/everything/resources/` and are registered via `registerResources(server)`.
40- Prompts live under `src/everything/prompts/` and are registered via `registerPrompts(server)`.
41- Subscriptions and simulated update routines are under `src/everything/resources/subscriptions.ts`.
42- Logging helpers are under `src/everything/server/logging.ts`.
43- Transport managers are under `src/everything/transports/`.
44 
45### When adding a new feature
46 
47- Follow the existing file/module pattern in its folder (naming, exports, and registration function).
48- Export a `registerX(server)` function that registers new items with the MCP SDK in the same style as existing ones.
49- Wire your new module into the central index (e.g., update `tools/index.ts`, `resources/index.ts`, or `prompts/index.ts`).
50- Ensure schemas (for tools) are accurate JSON Schema and include helpful descriptions and examples.
51  `server/index.ts` and usages in `logging.ts` and `subscriptions.ts`.
52- Keep the docs in `src/everything/docs/` up to date if you add or modify noteworthy features.
53