MCP Demo Server

🚀 MCP Demonstration Server

This is a simple example project of a Model Context Protocol (MCP) server. It demonstrates how to use Python to build basic MCP tools.

🚀 Quick Start

This project showcases a straightforward MCP server example, demonstrating the creation of fundamental MCP tools using Python.

✨ Features

This project implements two simple MCP tools:

• add: A simple addition function that takes two integers and returns their sum.
• say_hello: A greeting function that takes a name parameter and returns a personalized greeting.

📦 Installation

Prerequisites

• Python 3.x
• MCP (Model Context Protocol) library
• uv (Python package management tool)

Steps

1. Clone this project:

git clone [repository-url]
cd mcp-demo

2. Create a virtual environment and install dependencies:

python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install mcp[cli]

💻 Usage Examples

Basic Usage

To start the MCP server, run:

uv run --with mcp[cli] mcp run server.py

Testing the Server

Test the MCP server in development mode:

mcp dev server.py

This command will:

1. Start the server in development mode.
2. Automatically reload the code upon changes.
3. Provide more detailed debugging information.

📚 Documentation

Project Structure

mcp-demo/
├── server.py        # Main program of the MCP server
├── .gitignore      # Git ignore file
└── README.md       # This document

Development Details

The server implements two basic tools:

1. add(a: int, b: int) -> int

   • Function: Adds two integers.
   • Parameters:
     • a: The first integer.
     • b: The second integer.
   • Return: The sum of the two integers.

2. say_hello(name: str) -> str

   • Function: Generates a personalized greeting.
   • Parameters:
     • name: The name of the person to greet.
   • Return: A string containing the greeting.

Configuration

The project includes a VS Code configuration file (.vscode/mcp.json), allowing you to directly run and test the MCP server in VS Code.

GitHub Copilot Setup

To use this MCP server with GitHub Copilot, follow these steps in VS Code:

1. Create a .vscode folder in the project root directory (if it doesn't exist).

2. Create a mcp.json file in the .vscode folder with the following content:

{
    "servers": {
      "Demo": {
        "command": "uv",
        "args": [
          "run",
          "--with",
          "mcp[cli]",
          "mcp",
          "run",
          "${workspaceFolder}/server.py"
        ]
      }
    }
}

3. After the setup is complete, GitHub Copilot will be able to automatically connect to your MCP server and use its provided tool functions.

⚠️ Important Note

• Ensure that the uv package management tool is correctly installed.
• ${workspaceFolder} will be automatically replaced with the path to your project root directory.
• If you use a different Python environment management tool, adjust the corresponding configuration accordingly.