Skip to content

Commit 002f854

Browse files
itay-tadataitay-tadata
committed
cosmetics
1 parent 3c8da6a commit 002f854

File tree

9 files changed

+146
-9
lines changed

9 files changed

+146
-9
lines changed

‎CHANGELOG.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.1.0] - 2024-03-08
9+
10+
### Added
11+
- Initial release of FastAPI-MCP
12+
- Core functionality for converting FastAPI applications to MCP servers
13+
- CLI tool for generating, running, and installing MCP servers
14+
- Automatic discovery of FastAPI endpoints
15+
- Type-safe conversion from FastAPI endpoints to MCP tools
16+
- Documentation preservation from FastAPI to MCP
17+
- Claude integration for easy installation and use
18+
- API integration that automatically makes HTTP requests to FastAPI endpoints
19+
- Examples directory with sample FastAPI application
20+
- Basic test suite

‎CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributing to FastAPI-MCP
2+
3+
First off, thank you for considering contributing to FastAPI-MCP!
4+
5+
## Development Process
6+
7+
1. Fork the repository
8+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
9+
3. Make your changes
10+
4. Run the tests (`pytest`)
11+
5. Format your code (`black .` and `isort .`)
12+
6. Commit your changes (`git commit -m 'Add some amazing feature'`)
13+
7. Push to the branch (`git push origin feature/amazing-feature`)
14+
8. Open a Pull Request
15+
16+
## Setting Up Development Environment
17+
18+
```bash
19+
# Clone your fork
20+
git clone https://github.com/tadata-org/fastapi_mcp
21+
cd fastapi-mcp
22+
23+
# Create a virtual environment
24+
python -m venv venv
25+
source venv/bin/activate # On Windows: venv\Scripts\activate
26+
27+
# Install development dependencies
28+
pip install -e ".[dev]"
29+
```
30+
31+
## Code Style
32+
33+
We use the following tools to ensure code quality:
34+
35+
- **Black** for code formatting
36+
- **isort** for import sorting
37+
- **ruff** for linting
38+
- **mypy** for type checking
39+
40+
Please make sure your code passes all checks before submitting a pull request:
41+
42+
```bash
43+
black .
44+
isort .
45+
ruff check .
46+
mypy .
47+
```
48+
49+
## Testing
50+
51+
We use pytest for testing. Please write tests for any new features and ensure all tests pass:
52+
53+
```bash
54+
pytest
55+
```
56+
57+
## Pull Request Process
58+
59+
1. Ensure your code follows the style guidelines of the project
60+
2. Update the README.md with details of changes if applicable
61+
3. The versioning scheme we use is [SemVer](http://semver.org/)
62+
4. Include a descriptive commit message
63+
5. Your pull request will be merged once it's reviewed and approved
64+
65+
## Code of Conduct
66+
67+
Please note we have a code of conduct, please follow it in all your interactions with the project.
68+
69+
- Be respectful and inclusive
70+
- Be collaborative
71+
- When disagreeing, try to understand why
72+
- A diverse community is a strong community
73+
74+
## Questions?
75+
76+
Don't hesitate to open an issue if you have any questions about contributing to FastAPI-MCP.

‎INSTALL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can also install FastAPI-MCP from source:
2121

2222
```bash
2323
# Clone the repository
24-
git clone https://github.com/yourusername/fastapi-mcp.git
24+
git clone https://github.com/tadata-org/fastapi_mcp.git
2525
cd fastapi-mcp
2626

2727
# Install the package

‎LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 FastAPI-MCP Team
3+
Copyright (c) 2024 Tadata Inc.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎MANIFEST.in

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
include LICENSE
2+
include README.md
3+
include INSTALL.md
4+
include pyproject.toml
5+
include setup.py
6+
7+
recursive-include examples *.py *.md
8+
recursive-include tests *.py
9+
10+
global-exclude *.py[cod] __pycache__ *.so *.dylib .DS_Store

‎README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,12 @@ For more examples, see the [examples](examples) directory.
183183

184184
## Contributing
185185

186-
Contributions are welcome! Please feel free to submit a pull request.
186+
Contributions are welcome! Please feel free to submit a pull request. See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
187187

188188
## License
189189

190-
MIT
190+
MIT License. Copyright (c) 2024 Tadata Inc.
191+
192+
## About
193+
194+
Developed and maintained by [Tadata Inc.](https://github.com/tadata-org)

‎fastapi_mcp/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
"""
22
FastAPI-MCP: Automatic MCP server generator for FastAPI applications.
3+
4+
Created by Tadata Inc. (https://github.com/tadata-org)
35
"""
46

57
__version__ = "0.1.0"

‎pyproject.toml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ build-backend = "hatchling.build"
55
[project]
66
name = "fastapi-mcp"
77
version = "0.1.0"
8-
description = "Automatic MCP server generator for FastAPI applications"
8+
description = "Automatic MCP server generator for FastAPI applications - converts FastAPI endpoints to MCP tools for LLM integration"
99
readme = "README.md"
1010
requires-python = ">=3.10"
1111
license = {file = "LICENSE"}
1212
authors = [
13-
{name = "FastAPI MCP Team", email = "contact@example.com"},
13+
{name = "Tadata Inc.", email = "itay@tadata.com"},
1414
]
1515
classifiers = [
1616
"Development Status :: 3 - Alpha",
@@ -20,16 +20,27 @@ classifiers = [
2020
"Programming Language :: Python :: 3.10",
2121
"Programming Language :: Python :: 3.11",
2222
"Programming Language :: Python :: 3.12",
23+
"Topic :: Software Development :: Libraries :: Python Modules",
24+
"Topic :: Internet :: WWW/HTTP",
25+
"Framework :: FastAPI",
2326
]
27+
keywords = ["fastapi", "mcp", "llm", "claude", "ai", "tools", "api", "conversion"]
2428
dependencies = [
2529
"fastapi>=0.100.0",
2630
"typer>=0.9.0",
2731
"rich>=13.0.0",
2832
"mcp>=1.3.0",
2933
"pydantic>=2.0.0",
3034
"uvicorn>=0.20.0",
35+
"requests>=2.25.0",
36+
"inspect-mate>=0.0.2",
3137
]
3238

39+
[project.urls]
40+
Homepage = "https://github.com/tadata-org/fastapi_mcp"
41+
Documentation = "https://github.com/tadata-org/fastapi_mcp#readme"
42+
"Bug Tracker" = "https://github.com/tadata-org/fastapi_mcp/issues"
43+
3344
[project.optional-dependencies]
3445
dev = [
3546
"pytest>=7.0.0",

‎setup.py

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
setup(
44
name="fastapi-mcp",
55
version="0.1.0",
6-
description="Automatic MCP server generator for FastAPI applications",
7-
author="FastAPI MCP Team",
8-
author_email="contact@example.com",
6+
description="Automatic MCP server generator for FastAPI applications - converts FastAPI endpoints to MCP tools for LLM integration",
7+
author="Tadata Inc.",
8+
author_email="itay@tadata.com",
99
packages=["fastapi_mcp"],
1010
python_requires=">=3.10",
1111
install_requires=[
@@ -15,11 +15,25 @@
1515
"mcp>=1.3.0",
1616
"pydantic>=2.0.0",
1717
"uvicorn>=0.20.0",
18+
"requests>=2.25.0",
1819
"inspect-mate>=0.0.2",
1920
],
2021
entry_points={
2122
"console_scripts": [
2223
"fastapi-mcp=fastapi_mcp.cli:app",
2324
],
2425
},
26+
classifiers=[
27+
"Development Status :: 3 - Alpha",
28+
"Intended Audience :: Developers",
29+
"License :: OSI Approved :: MIT License",
30+
"Programming Language :: Python :: 3",
31+
"Programming Language :: Python :: 3.10",
32+
"Programming Language :: Python :: 3.11",
33+
"Programming Language :: Python :: 3.12",
34+
"Topic :: Software Development :: Libraries :: Python Modules",
35+
"Topic :: Internet :: WWW/HTTP",
36+
"Framework :: FastAPI",
37+
],
38+
keywords=["fastapi", "mcp", "llm", "claude", "ai", "tools", "api", "conversion"],
2539
)

0 commit comments

Comments
 (0)