Skip to main content

CLI tools for MCP (Model Context Protocol) server setup and management with OIDC support (Auth0, Dex, Keycloak)

Project description

MCP Base

CLI tools for MCP (Model Context Protocol) server setup and management. These tools help you configure OIDC authentication, create Kubernetes secrets, set up RBAC, and manage MCP server deployments.

Installation

From PyPI

# Install base package (OIDC tools only)
pip install mcp-base

# Install with Kubernetes support
pip install mcp-base[kubernetes]

# Install all optional dependencies
pip install mcp-base[all]

From Source

git clone https://github.com/your-org/mcp-base.git
cd mcp-base
pip install -e ".[all]"

Usage

After installation, the mcp-base command is available with the following subcommands:

mcp-base <command> [options]
Command Description
setup-oidc Set up OIDC provider (Auth0, Dex, Keycloak, etc.) for MCP authentication
create-secrets Create Kubernetes secrets for MCP deployment
setup-rbac Set up Kubernetes RBAC resources
add-user Add users to allowed clients

Setting Up OIDC

Configure your OIDC provider for MCP authentication.

Supported providers: auth0, dex, keycloak, okta, generic

Each provider resolves to one of two authentication patterns (see imp/cli-integration-contract.md §1):

Pattern Providers How it works Needs pre-registered client Needs K8s Secrets
A — OAuth Proxy auth0, dex, okta, generic FastMCP runs an OAuth Proxy in front of the IdP yes yes (<release>-oidc-credentials + <release>-jwt-signing-key)
B — Remote DCR keycloak (≥ 26.6.0 + FastMCP ≥ 3.2.4) FastMCP's KeycloakAuthProvider uses Keycloak's native Dynamic Client Registration no no (create-secrets is a no-op)

To see all provider options and examples:

mcp-base setup-oidc --help

To get help for a specific provider:

mcp-base setup-oidc --provider dex --help

1. Auth0 (Automated Setup)

The CLI automatically configures your Auth0 tenant:

# Set up Auth0 (first run)
mcp-base setup-oidc --provider auth0 \
    --domain your-tenant.auth0.com \
    --api-identifier https://mcp-server.example.com/mcp \
    --token YOUR_MGMT_TOKEN

# Subsequent runs (uses saved configuration)
mcp-base setup-oidc --provider auth0

# Force recreate clients (if secrets are lost)
mcp-base setup-oidc --provider auth0 --recreate-client

2. Dex, Keycloak, Okta, or Generic OIDC (Pre-configured)

For providers where you already have client credentials configured:

# Interactive mode (prompts for values)
mcp-base setup-oidc --provider dex

# Non-interactive mode
mcp-base setup-oidc --provider dex \
    --issuer https://dex.example.com \
    --audience https://mcp-server.example.com/mcp \
    --client-id YOUR_CLIENT_ID \
    --client-secret YOUR_CLIENT_SECRET

# Keycloak (Pattern B — native DCR). See KEYCLOAK-HOWTO.md for realm/DCR setup.
# Requires FastMCP >= 3.2.4 on the MCP server AND Keycloak >= 26.6.0 on the IdP.
# No --client-id / --client-secret are required; any that are passed are ignored.
mcp-base setup-oidc --provider keycloak \
    --issuer https://keycloak.example.com/realms/myrealm \
    --audience https://mcp-server.example.com/mcp

# Okta
mcp-base setup-oidc --provider okta \
    --issuer https://your-org.okta.com \
    --audience https://mcp-server.example.com/mcp \
    --client-id YOUR_CLIENT_ID \
    --client-secret YOUR_CLIENT_SECRET

# Any generic OIDC provider
mcp-base setup-oidc --provider generic \
    --issuer https://your-idp.com \
    --audience https://mcp-server.example.com/mcp \
    --client-id YOUR_CLIENT_ID \
    --client-secret YOUR_CLIENT_SECRET

Required Redirect URLs

Configure these redirect URLs in your OIDC provider:

  • MCP Server: https://mcp-server.example.com/auth/callback (replace with your actual server URL)
  • Claude Desktop: https://claude.ai/api/mcp/auth_callback
  • Local testing (optional): http://localhost:8888/callback, http://localhost:8889/callback

Endpoint resolution

When setup-oidc validates the issuer (the default), the authorization_endpoint, token_endpoint, and jwks_uri are read from the provider's .well-known/openid-configuration and saved verbatim to oidc-config.json. Pass --skip-validation to bypass the HTTP probe; in that case the endpoints are derived from provider-specific fallbacks:

Provider Auth Token JWKS
keycloak {issuer}/protocol/openid-connect/auth {issuer}/protocol/openid-connect/token {issuer}/protocol/openid-connect/certs
okta {issuer}/v1/authorize {issuer}/v1/token {issuer}/v1/keys
dex, generic {issuer}/auth {issuer}/token {issuer}/.well-known/jwks.json

Creating Kubernetes Secrets

Create secrets required for MCP server deployment:

# Create secrets in a namespace
mcp-base create-secrets --namespace default --release-name my-mcp-server

# Dry run to see what would be created
mcp-base create-secrets --namespace default --release-name my-mcp-server --dry-run

# Replace existing secrets
mcp-base create-secrets --namespace default --release-name my-mcp-server --force

Pattern A (auth0, dex, okta, generic) creates two Secrets:

  • <release-name>-oidc-credentials — client ID/secret (+ Auth0 mgmt fields when applicable)
  • <release-name>-jwt-signing-key — JWT signing key + storage encryption key

Pattern B (keycloak native DCR): create-secrets is a no-op. It reads oidc-config.json, sees pattern: "remote", prints a notice, and exits 0 without contacting the Kubernetes API.

Setting Up RBAC

Configure Kubernetes RBAC for MCP server:

# Cluster-wide permissions
mcp-base setup-rbac --namespace production --app-name my-mcp-server

# Namespace-scoped permissions
mcp-base setup-rbac --namespace production --app-name my-mcp-server --scope namespace

# Dry run
mcp-base setup-rbac --app-name my-mcp-server --dry-run

# Delete RBAC resources
mcp-base setup-rbac --app-name my-mcp-server --delete

Adding Users to Allowed Clients

Add users to the allowedClients array in your OIDC provider:

# Interactive mode
mcp-base add-user

# Non-interactive
mcp-base add-user --email user@example.com --client-type both

Dependencies

Required

  • requests>=2.28.0 - HTTP client for Auth0 API

Optional (Kubernetes support)

  • kubernetes>=28.0.0 - Kubernetes Python client
  • cryptography>=41.0.0 - For generating encryption keys

Install with: pip install mcp-base[kubernetes]

Development

Setup

# Clone the repository
git clone https://github.com/your-org/mcp-base.git
cd mcp-base

# Install in development mode with all dependencies
pip install -e ".[dev]"

Running Tests

pytest

Code Quality

# Format code
black src/

# Lint
ruff check src/

# Type checking
mypy src/

Publishing to PyPI

Prerequisites

  1. Create an account on PyPI and Test PyPI
  2. Install build tools:
    pip install build twine
    
  3. Create API tokens and save them locally (git-ignored):
    echo "pypi-YOUR_TEST_TOKEN" > test.token && chmod 600 test.token
    echo "pypi-YOUR_PROD_TOKEN" > prod.token && chmod 600 prod.token
    

Makefile (preferred)

make build    # Clean + build only; artifacts in dist/
make test     # Run pytest
make dev      # Publish to Test PyPI using ./test.token
make prod     # Publish to production PyPI using ./prod.token (prompts "yes" to confirm)
make clean    # Remove dist/, build/, *.egg-info

make dev / make prod refuse to run if the expected token file is missing or empty.

Build the Package Manually

# Clean previous builds
rm -rf dist/ build/ *.egg-info src/*.egg-info

# Build source distribution and wheel
python -m build

This creates:

  • dist/mcp_base-0.1.0.tar.gz (source distribution)
  • dist/mcp_base-0.1.0-py3-none-any.whl (wheel)

Test on Test PyPI (Recommended)

# Upload to Test PyPI
python -m twine upload --repository testpypi dist/*

# Or with a token file
python -m twine upload --repository testpypi dist/* -u __token__ -p "$(cat ~/.testpypi-token)"

# Test installation from Test PyPI
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ mcp-base

Publish to PyPI

# Upload to PyPI
python -m twine upload dist/*

Using API Tokens (Recommended)

Instead of username/password, use API tokens:

  1. Go to PyPI > Account Settings > API tokens
  2. Create a token with scope "Entire account" or project-specific
  3. Use the token directly:
    python -m twine upload dist/* -u __token__ -p pypi-YOUR_TOKEN_HERE
    

Using a Token File

For better security, store your token in a file and read it during upload:

# Store token in a file (do this once)
echo "pypi-YOUR_TOKEN_HERE" > ~/.pypi-token
chmod 600 ~/.pypi-token

# Upload using the token file
python -m twine upload dist/* -u __token__ -p "$(cat ~/.pypi-token)"

# Or using environment variables
TWINE_PASSWORD=$(cat ~/.pypi-token) python -m twine upload dist/*

Using .pypirc Configuration File

Or create ~/.pypirc:

[pypi]
username = __token__
password = pypi-YOUR_TOKEN_HERE

[testpypi]
username = __token__
password = pypi-YOUR_TEST_TOKEN_HERE

Automated Publishing with GitHub Actions

Create .github/workflows/publish.yml:

name: Publish to PyPI

on:
  release:
    types: [published]

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'

      - name: Install build dependencies
        run: pip install build twine

      - name: Build package
        run: python -m build

      - name: Publish to PyPI
        env:
          TWINE_USERNAME: __token__
          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
        run: python -m twine upload dist/*

Add your PyPI API token as a repository secret named PYPI_API_TOKEN.

License

MIT License - see LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_base-0.5.0.tar.gz (45.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_base-0.5.0-py3-none-any.whl (46.0 kB view details)

Uploaded Python 3

File details

Details for the file mcp_base-0.5.0.tar.gz.

File metadata

  • Download URL: mcp_base-0.5.0.tar.gz
  • Upload date:
  • Size: 45.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for mcp_base-0.5.0.tar.gz
Algorithm Hash digest
SHA256 3bf7601d1c0ebdd5fed63449e510e3dfb06b296aa7904c177a057922117b61af
MD5 489ecba7bcad66cec365a9f2d1357194
BLAKE2b-256 20d910f59ab8b0cdab4855b7287eeef7d8482c9124f6ea28d740fcaa75159a15

See more details on using hashes here.

File details

Details for the file mcp_base-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: mcp_base-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 46.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for mcp_base-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e84b535ce45a40df7dfce8aea5145be649eea131aab8c73daa5ef73f0a4581fd
MD5 28712d5a68c5cb47f0272fb71d7fdd34
BLAKE2b-256 751a0f35c49757c76e5dd7817eeeb2f2389898e3e39aeef9f4c938731b5a5576

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page