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:
commit
76d64c822f
3 changed files with 13 additions and 3 deletions
|
|
@ -113,7 +113,7 @@ npm run start:streamableHttp
|
|||
### Install
|
||||
```shell
|
||||
npm install -g @modelcontextprotocol/server-everything@latest
|
||||
````
|
||||
```
|
||||
|
||||
### Run the default (stdio) server
|
||||
```shell
|
||||
|
|
|
|||
|
|
@ -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)`.
|
||||
|
|
|
|||
|
|
@ -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/`
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue