Merge pull request #4527 from Joosboy/docs-everything-4096-references-formatting

docs(everything): fix markdown formatting and instructions file references
This commit is contained in:
Den Delimarsky 2026-07-29 16:09:46 -07:00 • committed by GitHub
commit 76d64c822f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 13 additions and 3 deletions

View file

@ -113,7 +113,7 @@ npm run start:streamableHttp
### Install ### Install
```shell ```shell
npm install -g @modelcontextprotocol/server-everything@latest npm install -g @modelcontextprotocol/server-everything@latest
```` ```
### Run the default (stdio) server ### Run the default (stdio) server
```shell ```shell

View file

@ -54,7 +54,7 @@
- `prompts: {}` - `prompts: {}`
- `resources: { subscribe: true }` - `resources: { subscribe: true }`
- **Server Instructions** - **Server Instructions**
- Loaded from the docs folder (`server-instructions.md`). - Loaded from the docs folder (`instructions.md`).
- **Registrations** - **Registrations**
- Registers **tools** via `registerTools(server)`. - Registers **tools** via `registerTools(server)`.
- Registers **resources** via `registerResources(server)`. - Registers **resources** via `registerResources(server)`.

View file

@ -85,9 +85,19 @@ src/everything
### `docs/` ### `docs/`
- `architecture.md` - `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` - `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. - 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/` ### `prompts/`