Skip to main content

Python WSGI middleware for Model Context Protocol (MCP)

Project description

Tidewave

Tidewave Web for Django, FastAPI, and Flask is currently in alpha testing!

Tidewave is the coding agent for full-stack web app development, deeply integrated with Python web frameworks, from the database to the UI. See our website for more information.

This project can also be used as a standalone Model Context Protocol (MCP) server for your editors.

Installation

Django

Add tidewave[django] as a dependency to your pyproject.toml:

"tidewave[django] @ git+https://github.com/tidewave-ai/tidewave_python.git",

Then open up your settings.py and add the following after your MIDDLEWARE and INSTALLED_APPS definition:

if DEBUG:
    INSTALLED_APPS.insert(0, "tidewave.django.apps.TidewaveConfig")
    MIDDLEWARE.insert(0, 'tidewave.django.Middleware')

If you are using Jinja2, you need to add our extension too (preferably in DEBUG mode only):

JINJA2_ENVIRONMENT_OPTIONS = {
    "extensions": [
        "tidewave.jinja2.Extension"
    ],
}

Now make sure Tidewave is installed and you are ready to connect Tidewave to your app.

Settings

  • ALLOWED_HOSTS - Tidewave use the same allowed origins as your app to validate access
  • TIDEWAVE["allow_remote_access"] - Whether to allow remote connections (default False)
  • TIDEWAVE["team"] - Enable your Tidewave Team configuration, such as TIDEWAVE = {"team": {"id": "dashbit"}}

Note Tidewave only runs in DEBUG mode.

Flask

Add tidewave[flask] as a dependency to your pyproject.toml:

"tidewave[flask] @ git+https://github.com/tidewave-ai/tidewave_python.git",

Now, in your application definition, you can initialize the Tidewave class and pass your Flask application to init_app:

if app.debug:
    from tidewave.flask import Tidewave
    tidewave = Tidewave()
    tidewave.init_app(app)

Note Tidewave only runs when app.debug is True. Therefore, remember to start your dev server with the --debug flag. If you are setting app.debug programatically, remember to do so before you call tidewave.init_app.

Now make sure Tidewave is installed and you are ready to connect Tidewave to your app.

Configuration

When initializing Tidewave(), the following options are supported:

  • allow_remote_access: allow remote connections when True (default False)
  • allowed_origins: list of allowed origin hosts (default [])
  • team: enable Tidewave Web for teams

Tidewave will automatically detect if your Flask application is using SQLAlchemy and Jinja2 and configure them automatically.

FastAPI

Tidewave Web is currently not supported for FastAPI.

Add tidewave[fastapi] as a dependency to your pyproject.toml:

"tidewave[fastapi] @ git+https://github.com/tidewave-ai/tidewave_python.git",

Now, in your application definition, you can initialize the Tidewave class and pass your FastAPI application to install. Note that you only want to do this in development mode:

# Your preferable way of detecting dev mode.
is_dev = os.environ.get("RUN_MODE", None) == "development"

if is_dev:
    from tidewave.fastapi import Tidewave
    tidewave = Tidewave()
    tidewave.install(app)

If you are using Jinja2, you need to add our extension too:

if is_dev:
    # ...

    from tidewave.jinja2 import Extension
    templates.env.add_extension(Extension)

If you are using SQLAlchemy, then you need to pass your Base class and the underlying engine as arguments to install:

tidewave.install(app, sqlalchemy_base=Base, sqlalchemy_engine=engine)

Note: when using SQLModel, you should set sqlalchemy_base=SQLModel.

Now make sure Tidewave is installed and you are ready to connect Tidewave to your app.

Configuration

When initializing Tidewave(), the following options are supported:

  • allow_remote_access: allow remote connections when True (default False)
  • allowed_origins: list of allowed origin hosts (default [])
  • team: enable Tidewave Web for teams

Troubleshooting

Tidewave expects your web application to be running on localhost. If you are not running on localhost, you may need to enable additional configuration, such as allow_remote_access.

Furthermore, Tidewave only runs while in DEBUG/app.debug mode on all frameworks.

If you want to use Docker for development, you either need to enable the configuration above or automatically redirect the relevant ports, as done by devcontainers. See our containers guide for more information.

Content security policy

If you have enabled Content-Security-Policy, Tidewave will automatically enable "unsafe-eval" under script-src in order for contextual browser testing to work correctly. It also disables the frame-ancestors directive.

Contributing

# Install
uv sync --only-dev

# Run tests
uv run python -m pytest

# Lint and format code
uv run ruff check --fix .
uv run ruff format .

Acknowledgements

A thank you to Rob Hudson for implementing the Django integration.

License

Copyright (c) 2025 Dashbit

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

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

tidewave-0.1.0.tar.gz (92.3 kB view details)

Uploaded Source

Built Distribution

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

tidewave-0.1.0-py3-none-any.whl (35.6 kB view details)

Uploaded Python 3

File details

Details for the file tidewave-0.1.0.tar.gz.

File metadata

  • Download URL: tidewave-0.1.0.tar.gz
  • Upload date:
  • Size: 92.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tidewave-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6c3c5a64c477c1cc04e7a06965a4fd5bfbd8eae23a8e47cdc4eff8b496387c48
MD5 3032a618e9774ef6d8bfa2f47f9e37a8
BLAKE2b-256 8a2fe5ecfaf881f0cba6a15f1893aefd756ff5ab527328c4902ffb0c15809b1d

See more details on using hashes here.

Provenance

The following attestation bundles were made for tidewave-0.1.0.tar.gz:

Publisher: release.yaml on tidewave-ai/tidewave_python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tidewave-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tidewave-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 35.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tidewave-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a185c4c420b0ed6769e7434eed4d8cb70a8a2310e1532aed0982c8a2265c85aa
MD5 ac4175e83b1caefcb72f8dc67b0137f7
BLAKE2b-256 8854bf6666e8dc024a95bf4d64b307564a4edf581c91c10f2352837cf9168daf

See more details on using hashes here.

Provenance

The following attestation bundles were made for tidewave-0.1.0-py3-none-any.whl:

Publisher: release.yaml on tidewave-ai/tidewave_python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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