Skip to content

Commit 41c9996

Browse files
authored
Merge pull request #449 from petervandenabeele/fix-readme-toc
Fix Table of Contents in README and markdown linter warnings.
2 parents 2ee962c + ec7a794 commit 41c9996

File tree

4 files changed

+20
-10
lines changed

4 files changed

+20
-10
lines changed

CLAUDE.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# MCP TypeScript SDK Guide
22

33
## Build & Test Commands
4-
```
4+
5+
```sh
56
npm run build # Build ESM and CJS versions
67
npm run lint # Run ESLint
78
npm test # Run all tests
@@ -10,6 +11,7 @@ npx jest -t "test name" # Run tests matching pattern
1011
```
1112

1213
## Code Style Guidelines
14+
1315
- **TypeScript**: Strict type checking, ES modules, explicit return types
1416
- **Naming**: PascalCase for classes/types, camelCase for functions/variables
1517
- **Files**: Lowercase with hyphens, test files with `.test.ts` suffix
@@ -20,6 +22,7 @@ npx jest -t "test name" # Run tests matching pattern
2022
- **Comments**: JSDoc for public APIs, inline comments for complex logic
2123

2224
## Project Structure
25+
2326
- `/src`: Source code with client, server, and shared modules
2427
- Tests alongside source files with `.test.ts` suffix
25-
- Node.js >= 18 required
28+
- Node.js >= 18 required

CODE_OF_CONDUCT.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ representative at an online or offline event.
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6262
reported to the community leaders responsible for enforcement at
63-
63+
6464
All complaints will be reviewed and investigated promptly and fairly.
6565

6666
All community leaders are obligated to respect the privacy and security of the
@@ -116,13 +116,13 @@ the community.
116116

117117
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118118
version 2.0, available at
119-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
120120

121121
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122122
enforcement ladder](https://github.com/mozilla/diversity).
123123

124124
[homepage]: https://www.contributor-covenant.org
125125

126126
For answers to common questions about this code of conduct, see the FAQ at
127-
https://www.contributor-covenant.org/faq. Translations are available at
128-
https://www.contributor-covenant.org/translations.
127+
<https://www.contributor-covenant.org/faq>. Translations are available at
128+
<https://www.contributor-covenant.org/translations>.

README.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# MCP TypeScript SDK ![NPM Version](https://img.shields.io/npm/v/%40modelcontextprotocol%2Fsdk) ![MIT licensed](https://img.shields.io/npm/l/%40modelcontextprotocol%2Fsdk)
22

33
## Table of Contents
4+
45
- [Overview](#overview)
56
- [Installation](#installation)
6-
- [Quickstart](#quickstart)
7+
- [Quickstart](#quick-start)
78
- [What is MCP?](#what-is-mcp)
89
- [Core Concepts](#core-concepts)
910
- [Server](#server)
@@ -18,11 +19,14 @@
1819
- [Echo Server](#echo-server)
1920
- [SQLite Explorer](#sqlite-explorer)
2021
- [Advanced Usage](#advanced-usage)
22+
- [Dynamic Servers](#dynamic-servers)
2123
- [Low-Level Server](#low-level-server)
2224
- [Writing MCP Clients](#writing-mcp-clients)
23-
- [Server Capabilities](#server-capabilities)
24-
- [Proxy OAuth Server](#proxy-authorization-requests-upstream)
25+
- [Proxy Authorization Requests Upstream](#proxy-authorization-requests-upstream)
2526
- [Backwards Compatibility](#backwards-compatibility)
27+
- [Documentation](#documentation)
28+
- [Contributing](#contributing)
29+
- [License](#license)
2630

2731
## Overview
2832

@@ -377,6 +381,7 @@ app.listen(PORT, () => {
377381
```
378382

379383
This stateless approach is useful for:
384+
380385
- Simple API wrappers
381386
- RESTful scenarios where each request is independent
382387
- Horizontally scaled deployments without shared session state
@@ -721,6 +726,7 @@ app.use(mcpAuthRouter({
721726
```
722727

723728
This setup allows you to:
729+
724730
- Forward OAuth requests to an external provider
725731
- Add custom token validation logic
726732
- Manage client registrations
@@ -834,7 +840,7 @@ app.listen(3000);
834840

835841
## Contributing
836842

837-
Issues and pull requests are welcome on GitHub at https://github.com/modelcontextprotocol/typescript-sdk.
843+
Issues and pull requests are welcome on GitHub at <https://github.com/modelcontextprotocol/typescript-sdk>.
838844

839845
## License
840846

SECURITY.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Security Policy
2+
23
Thank you for helping us keep the SDKs and systems they interact with secure.
34

45
## Reporting Security Issues

0 commit comments

Comments
 (0)