MCP Hackathon Docs

🚀 MCP Python SDK Documentation

This repository contains the documentation for the Model Context Protocol (MCP) Python SDK. The documentation is built using Sphinx and the Read the Docs theme.

🚀 Quick Start

The Model Context Protocol (MCP) is an open standard that defines how applications interact with Large Language Models (LLMs). This documentation aims to help developers:

• Understand the core concepts of MCP.
• Build MCP servers to expose resources, tools, and prompts.
• Create MCP clients to connect to MCP servers.
• Explore advanced topics and best practices.

✨ Features

FastMCP

Our documentation comprehensively covers FastMCP, an advanced Pythonic interface for building MCP servers. Originally developed as a standalone project, FastMCP has been integrated into the official MCP Python SDK. It provides a developer-friendly way to create MCP servers without excessive boilerplate code:

from mcp.server.fastmcp import FastMCP

mcp = FastMCP("Demo 🚀")

@mcp.tool()
def add(a: int, b: int) -> int:
    """Add two numbers"""
    return a + b

The SDK offers multiple ways to run the server:

• Development mode with MCP monitor.
• Integration with Claude Desktop.
• Direct execution for custom deployments.

📦 Installation

Build the Documentation

1. Install Dependencies First, ensure Python is installed. Then, install the required packages:

# Use conda (recommended)
conda activate cuda_test
pip install -r requirements.txt

# Or use pip in a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt

2. Build the Documentation To build the documentation:

make html

The built documentation will be located in the _build/html/ directory.

3. Live Preview For live preview with auto-reloading:

sphinx-autobuild . _build/html

Then open http://localhost:8000 in your browser.

Host on GitHub Pages

You can host this documentation on GitHub Pages by following these steps:

1. Create a New Repository

• Log in to GitHub.
• Click "New repository".
• Fill in the repository name (e.g., yourusername/mcp-docs).
• Choose to initialize the repository content.
• Click "Create repository".

2. Upload the Documentation

• In the new repository, navigate to "Settings".
• Select "Pages" from the left menu.
• Choose the main branch or gh-pages branch from the dropdown list.
• Save the changes.

3. Access Your Documentation Website

• After completion, GitHub Pages will automatically generate a URL, similar to: https://yourusername.github.io/mcp-docs/.
• Visit the link to view your hosted MCP documentation.

📚 Documentation

Contribution Guidelines

Contributing to the documentation to improve its content is highly welcome! Here are the contribution steps:

1. Fork the Repository Fork this repository on GitHub to your account.

2. Create a Feature Branch

• Clone the forked repository locally: git clone https://github.com/yourusername/mcp-docs.git
• Create a new branch: git checkout -b feature/new-documentation

3. Commit Changes After modifying the documentation, commit to your new branch:

git add .
git commit -m "Improve documentation structure and content"

4. Push to GitHub Push the changes to the remote repository:

git push origin feature/new-documentation

5. Submit a Pull Request Under the "Pull Requests" tab of the original repository, click "New Pull Request". Select your forked repository and feature branch as the source, then submit the request.

Resources

• Official MCP Website
• MCP Python SDK GitHub
• MCP Specification
• Officially Supported Servers
• GitHub Discussions
• FastMCP GitHub (Legacy)

📄 License

This documentation is licensed under the MIT License. Please refer to the LICENSE file for details.