Skip to content

Commit 76d64c8

Browse files
authored
Merge pull request #4527 from Joosboy/docs-everything-4096-references-formatting
docs(everything): fix markdown formatting and instructions file references
2 parents 1cd1096 + 63df72c commit 76d64c8

3 files changed

Lines changed: 13 additions & 3 deletions

File tree

src/everything/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ npm run start:streamableHttp
113113
### Install
114114
```shell
115115
npm install -g @modelcontextprotocol/server-everything@latest
116-
````
116+
```
117117

118118
### Run the default (stdio) server
119119
```shell

src/everything/docs/startup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
- `prompts: {}`
5555
- `resources: { subscribe: true }`
5656
- **Server Instructions**
57-
- Loaded from the docs folder (`server-instructions.md`).
57+
- Loaded from the docs folder (`instructions.md`).
5858
- **Registrations**
5959
- Registers **tools** via `registerTools(server)`.
6060
- Registers **resources** via `registerResources(server)`.

src/everything/docs/structure.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,19 @@ src/everything
8585
### `docs/`
8686

8787
- `architecture.md`
88-
- This document.
88+
- Describes the server architecture, including transport layers, session initialization, and primitive registration.
89+
- `extension.md`
90+
- Explains how to extend the server with new tools, prompts, resources, or transports.
91+
- `features.md`
92+
- A comprehensive reference listing all implemented prompts, resources, tools, and protocol behaviors.
93+
- `how-it-works.md`
94+
- Explains how SSE and Streamable HTTP transports are set up and how sessions are managed.
8995
- `instructions.md`
9096
- 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.
97+
- `startup.md`
98+
- Describes the server startup sequence, environment checks, and initialization.
99+
- `structure.md`
100+
- This document.
91101

92102
### `prompts/`
93103

0 commit comments

Comments
 (0)