README.md•3.5 kB
# marvin-mcp-server
[![Tests][tests-badge]][tests-link]
[![uv][uv-badge]][uv-link]
[![Ruff][ruff-badge]][ruff-link]
\
[![Made Using tsvikas/python-template][template-badge]][template-link]
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
[![PRs Welcome][prs-welcome-badge]][prs-welcome-link]
## Overview
MCP server for amazing marvin.
## Usage
Install the package using pip, or with a dependency manager like uv:
```bash
pip install git+https://github.com/tsvikas/marvin-mcp-server.git`
```
<!---
# TODO: replace with this after uploading to PyPI:
pip install marvin-mcp-server
-->
and import the package in your code:
```python
import marvin_mcp_server
```
## Development
### Getting started
- install [git][install-git], [uv][install-uv].
- git clone this repo:
`git clone https://github.com/tsvikas/marvin-mcp-server.git`
or `gh repo clone tsvikas/marvin-mcp-server.git`
- run `uv run just prepare`
### Tests and code quality
- use `uv run just format` to format the code.
- use `uv run just lint` to see linting errors.
- use `uv run just test` to run tests.
- use `uv run just check` to run all the checks (format, lint, test, and pre-commit).
- Run a specific tool directly, with
`uv run pytest`/`ruff`/`mypy`/`black`/`pre-commit`/...
<!--- Badges to add after adding RTD documentation
[![Documentation Status][rtd-badge]][rtd-link]
[rtd-badge]: https://readthedocs.org/projects/marvin-mcp-server/badge/?version=latest
[rtd-link]: https://marvin-mcp-server.readthedocs.io/en/latest/?badge=latest
-->
<!--- Badges to add after writing tests. Also follow the link to finish setup
[![codecov][codecov-badge]][codecov-link]
[codecov-badge]: https://codecov.io/gh/tsvikas/marvin-mcp-server/graph/badge.svg
[codecov-link]: https://codecov.io/gh/tsvikas/marvin-mcp-server
-->
<!--- Badges to add after uploading to PyPI
[![PyPI version][pypi-version-badge]][pypi-link]
[![PyPI platforms][pypi-platforms-badge]][pypi-link]
[![Total downloads][pepy-badge]][pepy-link]
[pepy-badge]: https://img.shields.io/pepy/dt/marvin-mcp-server
[pepy-link]: https://pepy.tech/project/marvin-mcp-server
[pypi-link]: https://pypi.org/project/marvin-mcp-server/
[pypi-platforms-badge]: https://img.shields.io/pypi/pyversions/marvin-mcp-server
[pypi-version-badge]: https://img.shields.io/pypi/v/marvin-mcp-server
-->
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
[github-discussions-link]: https://github.com/tsvikas/marvin-mcp-server/discussions
[install-git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
[install-uv]: https://docs.astral.sh/uv/getting-started/installation/
[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
[prs-welcome-link]: http://makeapullrequest.com
[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
[ruff-link]: https://github.com/astral-sh/ruff
[template-badge]: https://img.shields.io/badge/%F0%9F%9A%80_Made_Using-tsvikas%2Fpython--template-gold
[template-link]: https://github.com/tsvikas/python-template
[tests-badge]: https://github.com/tsvikas/marvin-mcp-server/actions/workflows/ci.yml/badge.svg
[tests-link]: https://github.com/tsvikas/marvin-mcp-server/actions/workflows/ci.yml
[uv-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json
[uv-link]: https://github.com/astral-sh/uv