Skip to content

Commit

Permalink
simple python project to create an mcp server from the included template
Browse files Browse the repository at this point in the history
  • Loading branch information
dsp-ant committed Nov 18, 2024
0 parents commit 10bde5e
Show file tree
Hide file tree
Showing 9 changed files with 732 additions and 0 deletions.
162 changes: 162 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
.pdm.toml
.pdm-python
.pdm-build/

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
77 changes: 77 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# MCP Create Server

[![PyPI](https://img.shields.io/pypi/v/mcp-create-server)](https://pypi.org/project/mcp-create-server/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Create MCP server projects with no build configuration.

## Quick Overview

```sh
# Using pip
pip install mcp-create-server
create-mcp-server

# Or using uvx (recommended)
uvx create-mcp-server
```

You don't need to install or configure any dependencies manually. The tool will set up everything you need to create an MCP server.

## Creating a Server

**You'll need to have uv >= 0.4.10 installed on your machine.**

To create a new server, run either of these commands:

### Using pip
```sh
pip install mcp-create-server
create-mcp-server
```

### Using uvx (recommended)
```sh
uvx create-mcp-server
```

It will walk you through creating a new MCP server project. When complete, you'll have a new directory with this structure:

```
my-server/
├── README.md
├── pyproject.toml
├── src/
│ └── my_server/
│ ├── __init__.py
│ └── server.py
└── tests/
└── __init__.py
```

No configuration or complicated folder structures, only the files you need to run your server.

Once installation is done, you can start the server:

```sh
cd my-server
uv sync --dev --all-extras
uv run my-server
```

## Features

- Simple command-line interface for creating new projects
- Auto-configures Claude Desktop app integration when available
- Uses uv for fast, reliable package management
- Sets up basic MCP server structure
- Includes example endpoints

## Philosophy

- **Zero Configuration:** No need to manually set up project structure or dependencies.
- **Best Practices:** Follows Python packaging standards and MCP server patterns.
- **Batteries Included:** Comes with everything needed to start building an MCP server.

## License

Create MCP Server is open source software [licensed as MIT](https://opensource.org/licenses/MIT).
20 changes: 20 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[project]
name = "create-mcp-server"
version = "1.0.0"
description = "Create an MCP server project from a template."
readme = "README.md"
requires-python = ">=3.10"
dependencies = ["click>=8.1.7", "packaging>=24.2"]

[project.scripts]
create-mcp-server = "create_mcp_server:main"

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.hatch.build.targets.wheel]
artifacts = ["template"]

[tool.uv]
dev-dependencies = ["ruff>=0.7.4"]
Loading

0 comments on commit 10bde5e

Please sign in to comment.