MCP服务器模板

# Clone the template
git clone <your-repo-url> your-mcp-server
cd your-mcp-server

# Remove existing git history (optional)
rm -rf .git
git init

# Test what changes would be made (dry run)
python scripts/rename_project.py --dry-run your_server_name

# Rename everything at once
python scripts/rename_project.py your_server_name

# Install development dependencies
uv sync --all-extras

# Copy environment configuration
cp .env.example .env

# Run with STDIO transport (default)
make run

# Or run directly
uv run python -m mcp_boilerplate.main

# Debug mode
make run-debug

# Run with SSE transport for web integration
make run-sse

# Or run SSE directly
uv run --extra sse python -m mcp_boilerplate.main --transport sse --port 8000

# Run tests
make test

# Run with coverage
make test-cov

# Code quality checks
make lint
make type-check

{
  "mcpServers": {
    "your-server-name": {
      "command": "uv",
      "args": ["run", "python", "-m", "mcp_boilerplate.main"],
      "cwd": "/path/to/your-mcp-server"
    }
  }
}

src/mcp_boilerplate/
├── __init__.py
├── main.py              # CLI entry point
├── server.py            # Core server implementation
├── config/
│   ├── __init__.py
│   └── settings.py      # Configuration management
├── tools/               # MCP tools
│   ├── __init__.py
│   ├── math_tools.py
│   ├── text_tools.py
│   └── utility_tools.py
├── resources/           # MCP resources
│   ├── __init__.py
│   ├── system_resources.py
│   └── data_resources.py
├── prompts/             # MCP prompts
│   ├── __init__.py
│   ├── assistant_prompts.py
│   └── analysis_prompts.py
├── handlers/            # Error handling
│   ├── __init__.py
│   └── error_handler.py
└── utils/               # Utilities
    ├── __init__.py
    ├── logger.py
    └── validation.py

# Remove example tools (keep only what you want)
rm src/your_server_name/tools/math_tools.py
rm src/your_server_name/tools/text_tools.py
# Keep utility_tools.py or customize it

# Remove example resources
rm src/your_server_name/resources/data_resources.py
# Keep system_resources.py for monitoring

# Remove example prompts (if you don't need them)
rm -rf src/your_server_name/prompts/

# Add to pyproject.toml dependencies
dependencies = [
    # ... existing dependencies
    "sqlalchemy>=2.0.0",
    "asyncpg>=0.28.0",  # for PostgreSQL
]

# Create database tools
@mcp.tool
def query_database(sql: str) -> str:
    """Execute a database query."""
    # Your database implementation with proper validation
    pass

# Add HTTP client dependency
dependencies = [
    # ... existing dependencies
    "httpx>=0.24.0",
]

# Create API tools
@mcp.tool
async def call_external_api(endpoint: str) -> str:
    """Call an external API."""
    # Your API implementation with error handling
    pass

@mcp.tool
def read_file(file_path: str) -> str:
    """Read a file from the filesystem."""
    # Implement with proper security checks and path validation
    pass

@mcp.resource("file://{path}")
def get_file_content(path: str) -> str:
    """Get file content as a resource."""
    # Your implementation with security validation
    pass

# Setup development environment
make install-dev

# Run server
make run              # Production mode
make run-debug        # Debug mode

# Testing
make test             # Run tests
make test-cov         # Run with coverage

# Code quality
make lint             # Linting
make format           # Code formatting
make type-check       # Type checking

# All quality checks
make ci

# Build package
make build

# Server Configuration
SERVER_NAME=your-server-name
LOG_LEVEL=INFO
ENABLE_DEBUG=false
ENABLE_METRICS=true
MAX_REQUEST_SIZE=1048576
REQUEST_TIMEOUT=30

# Your Custom Variables
YOUR_API_KEY=your-api-key
YOUR_DATABASE_URL=postgresql://user:pass@localhost/db
YOUR_CUSTOM_SETTING=value

dependencies = [
    "fastmcp>=2.0.0",
    "pydantic>=2.0.0",
    "pydantic-settings>=2.0.0",
    # Add your dependencies here
    "your-required-library>=1.0.0",
]

# SSE transport support (optional)
[project.optional-dependencies]
sse = [
    "uvicorn>=0.24.0",
    "starlette>=0.32.0",
]

# Test with MCP Inspector
npx @modelcontextprotocol/inspector uv run python -m mcp_boilerplate.main

# Or if installed globally
mcp-inspector uv run python -m mcp_boilerplate.main

# Update tests to match your changes
make test

# Test with MCP Inspector
npx @modelcontextprotocol/inspector uv run python -m your_server_name.main

# Or if installed globally
mcp-inspector uv run python -m your_server_name.main

#!/bin/bash
# Usage: ./scripts/rename_project.sh new_name "New Description"

OLD_NAME="mcp_boilerplate"
NEW_NAME="$1"
NEW_DESC="$2"

if [ -z "$NEW_NAME" ]; then
    echo "Usage: $0 new_name \"New Description\""
    exit 1
fi

# Rename source directory
mv "src/${OLD_NAME}" "src/${NEW_NAME}"

# Update all Python files
find . -name "*.py" -exec sed -i "s/${OLD_NAME}/${NEW_NAME}/g" {} +

# Update pyproject.toml
sed -i "s/mcp-boilerplate/${NEW_NAME//_/-}/g" pyproject.toml
sed -i "s/mcp_boilerplate/${NEW_NAME}/g" pyproject.toml

if [ -n "$NEW_DESC" ]; then
    sed -i "s/A robust boilerplate template.*/${NEW_DESC}/g" pyproject.toml
fi

echo "Project renamed to ${NEW_NAME}"
echo "Don't forget to update README.md and other documentation!"