From 63df72cb15b14ba68d8eaedbe19127d4179131b1 Mon Sep 17 00:00:00 2001 From: Mahadev Annabhimoju <219508079+Joosboy@users.noreply.github.com> Date: Tue, 14 Jul 2026 20:05:30 +0530 Subject: [PATCH] docs(everything): fix markdown formatting and instructions file references --- src/everything/README.md | 2 +- src/everything/docs/startup.md | 2 +- src/everything/docs/structure.md | 12 +++++++++++- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/src/everything/README.md b/src/everything/README.md index a5943c6fce..f061e946a2 100644 --- a/src/everything/README.md +++ b/src/everything/README.md @@ -113,7 +113,7 @@ npm run start:streamableHttp ### Install ```shell npm install -g @modelcontextprotocol/server-everything@latest -```` +``` ### Run the default (stdio) server ```shell diff --git a/src/everything/docs/startup.md b/src/everything/docs/startup.md index 1d006589a9..5d70e985b1 100644 --- a/src/everything/docs/startup.md +++ b/src/everything/docs/startup.md @@ -54,7 +54,7 @@ - `prompts: {}` - `resources: { subscribe: true }` - **Server Instructions** - - Loaded from the docs folder (`server-instructions.md`). + - Loaded from the docs folder (`instructions.md`). - **Registrations** - Registers **tools** via `registerTools(server)`. - Registers **resources** via `registerResources(server)`. diff --git a/src/everything/docs/structure.md b/src/everything/docs/structure.md index bd3d70b95c..ff1e67dbc7 100644 --- a/src/everything/docs/structure.md +++ b/src/everything/docs/structure.md @@ -85,9 +85,19 @@ src/everything ### `docs/` - `architecture.md` - - This document. + - Describes the server architecture, including transport layers, session initialization, and primitive registration. +- `extension.md` + - Explains how to extend the server with new tools, prompts, resources, or transports. +- `features.md` + - A comprehensive reference listing all implemented prompts, resources, tools, and protocol behaviors. +- `how-it-works.md` + - Explains how SSE and Streamable HTTP transports are set up and how sessions are managed. - `instructions.md` - Human‑readable instructions intended to be passed to the client/LLM as guidance on server use. Loaded by the server at startup and returned in the initialize exchange. +- `startup.md` + - Describes the server startup sequence, environment checks, and initialization. +- `structure.md` + - This document. ### `prompts/`