chore: add markdownlint configuration and pre-commit hook for markdown files

dingo4dev · dingo4dev · commit 37eb86f5ede0 · 2025-06-20T17:23:01.000Z
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,23 @@
+default: true
+
+# MD004 ul-style - Unordered list style
+MD004: false
+
+# MD007 ul-indent - Unordered list indentation
+MD007:
+  indent: 4
+
+# MD013 line-length - Line length
+MD013: false
+
+# MD029 ol-prefix - Ordered list item prefix
+MD029: false
+
+# MD033 no-inline-html Inline HTML
+MD033: false
+
+# MD041 first-line-heading/first-line-h1
+MD041: false
+
+# MD059 descriptive-link-text
+MD059: false
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -7,6 +7,13 @@ repos:
       - id: prettier
         types_or: [yaml, json5]
 
+  - repo: https://github.com/DavidAnson/markdownlint-cli2
+    rev: v0.18.1
+    hooks:
+      - id: markdownlint-cli2
+        args: ["--fix"]
+        types: [markdown]
+
   - repo: local
     hooks:
       - id: ruff-format
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -26,15 +26,19 @@ This document contains critical information about working with this codebase. Fo
    - Bug fixes require regression tests
 
 - For commits fixing bugs or adding features based on user reports add:
+
   ```bash
   git commit --trailer "Reported-by:<name>"
   ```
+
   Where `<name>` is the name of the user.
 
 - For commits related to a Github issue, add
+
   ```bash
   git commit --trailer "Github-Issue:#<number>"
   ```
+
 - NEVER ever mention a `co-authored-by` or similar aspects. In particular, never
   mention the tool used to create the commit message or PR.
 
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-mcp-coc@anthropic.com.
+<mcp-coc@anthropic.com>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -116,13 +116,13 @@ the community.
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct
 enforcement ladder](https://github.com/mozilla/diversity).
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -9,6 +9,7 @@ Thank you for your interest in contributing to the MCP Python SDK! This document
 3. Fork the repository
 4. Clone your fork: `git clone https://github.com/YOUR-USERNAME/python-sdk.git`
 5. Install dependencies:
+
 ```bash
 uv sync --frozen --all-extras --dev
 ```
@@ -25,16 +26,19 @@ uv sync --frozen --all-extras --dev
 3. Make your changes
 
 4. Ensure tests pass:
-```bash 
+
+```bash
 uv run pytest
 ```
 
 5. Run type checking:
+
 ```bash
 uv run pyright
 ```
 
 6. Run linting:
+
 ```bash
 uv run ruff check .
 uv run ruff format .
diff --git a/README.md b/README.md
@@ -17,38 +17,38 @@
 ## Table of Contents
 
 - [MCP Python SDK](#mcp-python-sdk)
-  - [Overview](#overview)
-  - [Installation](#installation)
-    - [Adding MCP to your python project](#adding-mcp-to-your-python-project)
-    - [Running the standalone MCP development tools](#running-the-standalone-mcp-development-tools)
-  - [Quickstart](#quickstart)
-  - [What is MCP?](#what-is-mcp)
-  - [Core Concepts](#core-concepts)
-    - [Server](#server)
-    - [Resources](#resources)
-    - [Tools](#tools)
-    - [Prompts](#prompts)
-    - [Images](#images)
-    - [Context](#context)
-    - [Completions](#completions)
-    - [Elicitation](#elicitation)
-    - [Authentication](#authentication)
-  - [Running Your Server](#running-your-server)
-    - [Development Mode](#development-mode)
-    - [Claude Desktop Integration](#claude-desktop-integration)
-    - [Direct Execution](#direct-execution)
-    - [Mounting to an Existing ASGI Server](#mounting-to-an-existing-asgi-server)
-  - [Examples](#examples)
-    - [Echo Server](#echo-server)
-    - [SQLite Explorer](#sqlite-explorer)
-  - [Advanced Usage](#advanced-usage)
-    - [Low-Level Server](#low-level-server)
-    - [Writing MCP Clients](#writing-mcp-clients)
-    - [MCP Primitives](#mcp-primitives)
-    - [Server Capabilities](#server-capabilities)
-  - [Documentation](#documentation)
-  - [Contributing](#contributing)
-  - [License](#license)
+    - [Overview](#overview)
+    - [Installation](#installation)
+        - [Adding MCP to your python project](#adding-mcp-to-your-python-project)
+        - [Running the standalone MCP development tools](#running-the-standalone-mcp-development-tools)
+    - [Quickstart](#quickstart)
+    - [What is MCP?](#what-is-mcp)
+    - [Core Concepts](#core-concepts)
+        - [Server](#server)
+        - [Resources](#resources)
+        - [Tools](#tools)
+        - [Prompts](#prompts)
+        - [Images](#images)
+        - [Context](#context)
+        - [Completions](#completions)
+        - [Elicitation](#elicitation)
+        - [Authentication](#authentication)
+    - [Running Your Server](#running-your-server)
+        - [Development Mode](#development-mode)
+        - [Claude Desktop Integration](#claude-desktop-integration)
+        - [Direct Execution](#direct-execution)
+        - [Mounting to an Existing ASGI Server](#mounting-to-an-existing-asgi-server)
+    - [Examples](#examples)
+        - [Echo Server](#echo-server)
+        - [SQLite Explorer](#sqlite-explorer)
+    - [Advanced Usage](#advanced-usage)
+        - [Low-Level Server](#low-level-server)
+        - [Writing MCP Clients](#writing-mcp-clients)
+        - [MCP Primitives](#mcp-primitives)
+        - [Server Capabilities](#server-capabilities)
+    - [Documentation](#documentation)
+    - [Contributing](#contributing)
+    - [License](#license)
 
 [pypi-badge]: https://img.shields.io/pypi/v/mcp.svg
 [pypi-url]: https://pypi.org/project/mcp/
@@ -92,6 +92,7 @@ If you haven't created a uv-managed project yet, create one:
    ```
 
 Alternatively, for projects using pip for dependencies:
+
 ```bash
 pip install "mcp[cli]"
 ```
@@ -131,11 +132,13 @@ def get_greeting(name: str) -> str:
 ```
 
 You can install this server in [Claude Desktop](https://claude.ai/download) and interact with it right away by running:
+
 ```bash
 mcp install server.py
 ```
 
 Alternatively, you can test it with the MCP Inspector:
+
 ```bash
 mcp dev server.py
 ```
@@ -318,6 +321,7 @@ async def long_task(files: list[str], ctx: Context) -> str:
 MCP supports providing completion suggestions for prompt arguments and resource template parameters. With the context parameter, servers can provide completions based on previously resolved values:
 
 Client usage:
+
 ```python
 from mcp.client.session import ClientSession
 from mcp.types import ResourceTemplateReference
@@ -343,6 +347,7 @@ async def use_completion(session: ClientSession):
 ```
 
 Server implementation:
+
 ```python
 from mcp.server import Server
 from mcp.types import (
@@ -374,6 +379,7 @@ async def handle_completion(
                     return Completion(values=filtered)
     return None
 ```
+
 ### Elicitation
 
 Request additional information from users during tool execution:
@@ -415,6 +421,7 @@ async def book_table(date: str, party_size: int, ctx: Context) -> str:
 ```
 
 The `elicit()` method returns an `ElicitationResult` with:
+
 - `action`: "accept", "decline", or "cancel"
 - `data`: The validated response (only when accepted)
 - `validation_error`: Any validation error message
@@ -506,6 +513,7 @@ if __name__ == "__main__":
 ```
 
 Run it with:
+
 ```bash
 python server.py
 # or
@@ -583,10 +591,12 @@ app.mount("/math", math.mcp.streamable_http_app())
 ```
 
 For low level server with Streamable HTTP implementations, see:
+
 - Stateful server: [`examples/servers/simple-streamablehttp/`](examples/servers/simple-streamablehttp/)
 - Stateless server: [`examples/servers/simple-streamablehttp-stateless/`](examples/servers/simple-streamablehttp-stateless/)
 
 The streamable HTTP transport supports:
+
 - Stateful and stateless operation modes
 - Resumability with event stores
 - JSON or SSE response formats
@@ -759,6 +769,7 @@ async def query_db(name: str, arguments: dict) -> list:
 ```
 
 The lifespan API provides:
+
 - A way to initialize resources when the server starts and clean them up when it stops
 - Access to initialized resources through the request context in handlers
 - Type-safe context passing between lifespan and request handlers
@@ -949,6 +960,7 @@ async def display_resources(session: ClientSession):
 ```
 
 The `get_display_name()` function implements the proper precedence rules for displaying names:
+
 - For tools: `title` > `annotations.title` > `name`
 - For other objects: `title` > `name`
 
@@ -1007,7 +1019,6 @@ async def main():
 
 For a complete working example, see [`examples/clients/simple-auth-client/`](examples/clients/simple-auth-client/).
 
-
 ### MCP Primitives
 
 The MCP protocol defines three core primitives that servers can implement:
diff --git a/SECURITY.md b/SECURITY.md
@@ -1,4 +1,5 @@
 # Security Policy
+
 Thank you for helping us keep the SDKs and systems they interact with secure.
 
 ## Reporting Security Issues
diff --git a/examples/clients/simple-auth-client/README.md b/examples/clients/simple-auth-client/README.md
@@ -47,7 +47,7 @@ The client will open your browser for authentication. After completing OAuth, yo
 
 ## Example
 
-```
+```markdown
 🔐 Simple MCP Auth Client
 Connecting to: http://localhost:3001
 
diff --git a/examples/clients/simple-chatbot/README.MD b/examples/clients/simple-chatbot/README.MD
@@ -25,11 +25,12 @@ This example demonstrates how to integrate the Model Context Protocol (MCP) into
    ```plaintext
    LLM_API_KEY=your_api_key_here
    ```
+
    **Note:** The current implementation is configured to use the Groq API endpoint (`https://api.groq.com/openai/v1/chat/completions`) with the `llama-3.2-90b-vision-preview` model. If you plan to use a different LLM provider, you'll need to modify the `LLMClient` class in `main.py` to use the appropriate endpoint URL and model parameters.
 
 3. **Configure servers:**
 
-   The `servers_config.json` follows the same structure as Claude Desktop, allowing for easy integration of multiple servers. 
+   The `servers_config.json` follows the same structure as Claude Desktop, allowing for easy integration of multiple servers.
    Here's an example:
 
    ```json
@@ -46,9 +47,11 @@ This example demonstrates how to integrate the Model Context Protocol (MCP) into
      }
    }
    ```
+
    Environment variables are supported as well. Pass them as you would with the Claude Desktop App.
 
    Example:
+
    ```json
    {
      "mcpServers": {
@@ -72,7 +75,7 @@ This example demonstrates how to integrate the Model Context Protocol (MCP) into
    ```
 
 2. **Interact with the assistant:**
-   
+
    The assistant will automatically detect available tools and can respond to queries based on the tools provided by the configured servers.
 
 3. **Exit the session:**
@@ -86,6 +89,7 @@ This example demonstrates how to integrate the Model Context Protocol (MCP) into
 - **Server Integration**: Supports any MCP-compatible server, tested with various server implementations including Uvicorn and Node.js.
 
 ### Class Structure
+
 - **Configuration**: Manages environment variables and server configurations
 - **Server**: Handles MCP server initialization, tool discovery, and execution
 - **Tool**: Represents individual tools with their properties and formatting
@@ -107,5 +111,3 @@ This example demonstrates how to integrate the Model Context Protocol (MCP) into
      - If it's a direct response → return to user
    - Tool results are sent back to LLM for interpretation
    - Final response is presented to user
-
-
diff --git a/examples/servers/simple-auth/README.md b/examples/servers/simple-auth/README.md
diff --git a/examples/servers/simple-streamablehttp-stateless/README.md b/examples/servers/simple-streamablehttp-stateless/README.md
diff --git a/examples/servers/simple-streamablehttp/README.md b/examples/servers/simple-streamablehttp/README.md

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# Security Policy`
	`2`	`+`
`2`	`3`	`Thank you for helping us keep the SDKs and systems they interact with secure.`
`3`	`4`
`4`	`5`	`## Reporting Security Issues`