FastMCP server template with mcp-refcache and Langfuse tracing
Project description
FastMCP Template
A production-ready FastMCP server template with mcp-refcache integration for building AI agent tools that handle large data efficiently.
Features
- Reference-Based Caching - Return references instead of large data, reducing context window usage
- Preview Generation - Automatic previews for large results (sample, truncate, paginate strategies)
- Pagination - Navigate large datasets without loading everything at once
- Access Control - Separate user and agent permissions for sensitive data
- Private Computation - Let agents compute with values they cannot see
- Docker Ready - Production-ready containers with Chainguard secure base image
- Optional Langfuse Tracing - Built-in observability integration
Quick Start
Prerequisites
- Python 3.12+
- uv (recommended) or pip
Installation
# Clone the template
git clone https://github.com/l4b4r4b4b4/fastmcp-template
cd fastmcp-template
# Install dependencies
uv sync
# Run the server (stdio mode for Claude Desktop)
uv run fastmcp-template
# Run the server (SSE/HTTP mode for deployment)
uv run fastmcp-template --transport sse --port 8000
Docker Deployment
# Build and run with Docker Compose
docker compose up
# Or build images manually
docker build -f docker/Dockerfile.base -t fastmcp-base:latest .
docker build -f docker/Dockerfile -t fastmcp-template:latest .
docker run -p 8000:8000 fastmcp-template:latest
Using with Claude Desktop
Add to your claude_desktop_config.json:
{
"mcpServers": {
"fastmcp-template": {
"command": "uv",
"args": ["run", "fastmcp-template"],
"cwd": "/path/to/fastmcp-template"
}
}
}
Using with Zed
The template includes .zed/settings.json pre-configured for MCP context servers.
Example Tools
The template includes several example tools demonstrating different patterns:
Simple Tool (No Caching)
@mcp.tool
def hello(name: str = "World") -> dict[str, Any]:
"""Say hello to someone."""
return {"message": f"Hello, {name}!"}
Cached Tool (Public Namespace)
@mcp.tool
@cache.cached(namespace="public")
async def generate_items(count: int = 10, prefix: str = "item") -> list[dict]:
"""Generate items with automatic caching for large results."""
return [{"id": i, "name": f"{prefix}_{i}"} for i in range(count)]
Private Computation (EXECUTE Permission)
@mcp.tool
def store_secret(name: str, value: float) -> dict[str, Any]:
"""Store a secret that agents can use but not read."""
secret_policy = AccessPolicy(
user_permissions=Permission.FULL,
agent_permissions=Permission.EXECUTE, # Can use, cannot see
)
ref = cache.set(key=f"secret_{name}", value=value, policy=secret_policy)
return {"ref_id": ref.ref_id}
@mcp.tool
def compute_with_secret(secret_ref: str, multiplier: float = 1.0) -> dict[str, Any]:
"""Compute using a secret without revealing it."""
secret = cache.resolve(secret_ref, actor=DefaultActor.system())
return {"result": secret * multiplier}
Project Structure
fastmcp-template/
├── app/ # Application code (flat structure for containers)
│ ├── __init__.py # Version export
│ ├── server.py # Main server with example tools
│ └── tools/ # Additional tool modules
├── docker/
│ ├── Dockerfile.base # Chainguard-based secure base image
│ ├── Dockerfile # Production image (extends base)
│ └── Dockerfile.dev # Development with hot reload
├── tests/
│ ├── conftest.py # Pytest fixtures
│ └── test_server.py # Server tests
├── .github/
│ └── workflows/
│ ├── ci.yml # CI pipeline
│ ├── docker.yml # Docker build & publish to GHCR
│ └── release.yml # Release automation
├── docker-compose.yml # Local development & production
├── pyproject.toml # Project config
├── flake.nix # Nix dev shell
└── .rules # AI assistant guidelines
Development
Setup
# Install dependencies
uv sync
# Install pre-commit and pre-push hooks (configured in .pre-commit-config.yaml)
uv run pre-commit install --install-hooks
uv run pre-commit install --hook-type pre-push
Running Tests
uv run pytest
uv run pytest --cov # With coverage
Linting and Formatting
uv run ruff check . --fix
uv run ruff format .
Type Checking
uv run mypy app/
Docker Development
# Run development container with hot reload
docker compose --profile dev up
# Build base image (for publishing)
docker compose --profile build build base
# Build all images
docker compose build
Using Nix (Optional)
nix develop # Enter dev shell with all tools
Customization
- Rename the project: Update
pyproject.toml,app/, and imports - Add your tools: Create new tools in
app/server.pyor add modules toapp/tools/ - Configure caching: Adjust
RefCachesettings inapp/server.py - Add Langfuse: Install with
uv add langfuseand configure environment variables - Extend base image: Use
FROM ghcr.io/l4b4r4b4b4/fastmcp-base:latestin your Dockerfile
Configuration
Environment Variables
| Variable | Description | Default |
|---|---|---|
LANGFUSE_PUBLIC_KEY |
Langfuse public key | - |
LANGFUSE_SECRET_KEY |
Langfuse secret key | - |
LANGFUSE_HOST |
Langfuse host URL | https://cloud.langfuse.com |
CLI Options
uv run fastmcp-template --help
Options:
--transport {stdio,sse} Transport mode (default: stdio)
--port PORT Port for SSE transport (default: 8000)
--host HOST Host for SSE transport (default: 127.0.0.1)
Test Prompts
Use these prompts in a fresh chat session to verify the MCP server is working correctly. Each prompt demonstrates different capabilities of mcp-refcache.
🟢 Basic: Hello World
Prompt: "Say hello to 'MCP Developer' using the fastmcp-template tools"
Expected: The assistant calls hello with name="MCP Developer" and returns a greeting.
🟢 Basic: Health Check
Prompt: "Check if the fastmcp-template server is healthy"
Expected: The assistant calls health_check and reports server status.
🟡 Intermediate: Generate & Explore Items
Prompt: "Generate 50 widgets and tell me about the first and last items"
Expected: The assistant calls generate_items(count=50, prefix="widget") and describes widget_0 and widget_49.
🟡 Intermediate: Salary Calculator (Private Computation)
Prompt: "I want to calculate a 5% raise on my salary, but I don't want you to know my actual salary. Store $75,000 as a secret called 'current_salary', then calculate what it would be with a 5% raise."
Expected:
- Assistant calls
store_secret(name="current_salary", value=75000) - Assistant calls
compute_with_secret(secret_ref="...", multiplier=1.05) - Assistant reports the result ($78,750) without ever seeing the original value
🔴 Advanced: Multi-Step Private Computation
Prompt: "Help me compare two investment options without seeing my principal. Store $10,000 as 'principal'. Then calculate returns for: Option A (8% return) and Option B (12% return). Which is better?"
Expected:
- Assistant stores the secret principal
- Assistant computes both options using the same secret reference
- Assistant compares results ($10,800 vs $11,200) and recommends Option B
- The actual principal value is never revealed to the assistant
🔴 Advanced: Access Control Verification
Prompt: "Store my API key hash as a secret (use value 12345), then try to read it back directly using get_cached_result"
Expected:
- Assistant stores the secret successfully
- When attempting to read with
get_cached_result, it gets "access denied" - Assistant explains that secrets have EXECUTE-only permission for agents
🔴 Advanced: Admin Tool Verification
Prompt: "Show me the cache statistics using admin_get_cache_stats"
Expected: Assistant receives "Admin access required" error and explains that admin tools are permission-gated.
Test Coverage Summary
| Feature | Prompt Level | Tools Used |
|---|---|---|
| Basic greeting | 🟢 Basic | hello |
| Server health | 🟢 Basic | health_check |
| Item generation | 🟡 Intermediate | generate_items |
| Secret storage | 🟡 Intermediate | store_secret |
| Private computation | 🟡 Intermediate | compute_with_secret |
| Access control | 🔴 Advanced | get_cached_result |
| Admin gating | 🔴 Advanced | admin_* tools |
License
MIT License - see LICENSE for details.
Contributing
See CONTRIBUTING.md for development guidelines.
Related Projects
- mcp-refcache - Reference-based caching for MCP servers
- FastMCP - High-performance MCP server framework
- Model Context Protocol - The underlying protocol specification
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fastmcp_template-0.0.1.tar.gz.
File metadata
- Download URL: fastmcp_template-0.0.1.tar.gz
- Upload date:
- Size: 181.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2320187b2b8fde169dc23f7d8b339191087dae2bb5457320d20ea02b5500f921
|
|
| MD5 |
a3ec9dcd5eb1dab7915e7529d89cee88
|
|
| BLAKE2b-256 |
d94387cb9a4f4c45adec6128ef244c26d5fa8ea42a1f65bf7a64612096dfdb39
|
Provenance
The following attestation bundles were made for fastmcp_template-0.0.1.tar.gz:
Publisher:
publish.yml on l4b4r4b4b4/fastmcp-template
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
fastmcp_template-0.0.1.tar.gz -
Subject digest:
2320187b2b8fde169dc23f7d8b339191087dae2bb5457320d20ea02b5500f921 - Sigstore transparency entry: 763536176
- Sigstore integration time:
-
Permalink:
l4b4r4b4b4/fastmcp-template@acaa72f0b34c988f9556f884fb5e00246e249101 -
Branch / Tag:
refs/tags/v0.0.1 - Owner: https://github.com/l4b4r4b4b4
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@acaa72f0b34c988f9556f884fb5e00246e249101 -
Trigger Event:
release
-
Statement type:
File details
Details for the file fastmcp_template-0.0.1-py3-none-any.whl.
File metadata
- Download URL: fastmcp_template-0.0.1-py3-none-any.whl
- Upload date:
- Size: 26.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
087f52a71c081a33c16748144ef030a7da6e5c03cb95218eb24e01f3237354df
|
|
| MD5 |
d473a9ed81421f4bb79f262026dea96b
|
|
| BLAKE2b-256 |
532a6eb27126267e816fc586d89db208ef4a5b98503200bf339ab12d9eafd1e9
|
Provenance
The following attestation bundles were made for fastmcp_template-0.0.1-py3-none-any.whl:
Publisher:
publish.yml on l4b4r4b4b4/fastmcp-template
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
fastmcp_template-0.0.1-py3-none-any.whl -
Subject digest:
087f52a71c081a33c16748144ef030a7da6e5c03cb95218eb24e01f3237354df - Sigstore transparency entry: 763536179
- Sigstore integration time:
-
Permalink:
l4b4r4b4b4/fastmcp-template@acaa72f0b34c988f9556f884fb5e00246e249101 -
Branch / Tag:
refs/tags/v0.0.1 - Owner: https://github.com/l4b4r4b4b4
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@acaa72f0b34c988f9556f884fb5e00246e249101 -
Trigger Event:
release
-
Statement type: