Skip to content

Commit 2191f63

Browse files
drod75drod75
committed
Readme and venv
1 parent a258fd4 commit 2191f63

4 files changed

Lines changed: 767 additions & 2 deletions

File tree

‎.python-version‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.13

‎README.md‎

Lines changed: 168 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,168 @@
1-
# Math-MCP
2-
An MCP server meant to help Agents excel at Math!
1+
<a name="readme-top"></a>
2+
3+
<!-- PROJECT SHIELDS -->
4+
<!-- PROJECT LOGO -->
5+
<br />
6+
<div align="center">
7+
<a href="https://github.com/your_username/repo_name">
8+
<!-- <img src="images/logo.png" alt="Logo" width="80" height="80"> -->
9+
</a>
10+
11+
<h1 align="center">Math-MCP</h1>
12+
13+
<p align="center">
14+
A project to handle mathematical expressions and calculations.
15+
<br />
16+
<a href="https://github.com/your_username/repo_name"><strong>Explore the docs »</strong></a>
17+
<br />
18+
<br />
19+
<a href="https://github.com/your_username/repo_name">View Demo</a>
20+
·
21+
<a href="https://github.com/your_username/repo_name/issues">Report Bug</a>
22+
·
23+
<a href="https://github.com/your_username/repo_name/issues">Request Feature</a>
24+
</p>
25+
</div>
26+
27+
<!-- TABLE OF CONTENTS -->
28+
<details>
29+
<summary>Table of Contents</summary>
30+
<ol>
31+
<li>
32+
<a href="#about-the-project">About The Project</a>
33+
<ul>
34+
<li><a href="#built-with">Built With</a></li>
35+
</ul>
36+
</li>
37+
<li>
38+
<a href="#getting-started">Getting Started</a>
39+
<ul>
40+
<li><a href="#prerequisites">Prerequisites</a></li>
41+
<li><a href="#installation">Installation</a></li>
42+
</ul>
43+
</li>
44+
<li><a href="#usage">Usage</a></li>
45+
<li><a href="#roadmap">Roadmap</a></li>
46+
<li><a href="#contributing">Contributing</a></li>
47+
<li><a href="#license">License</a></li>
48+
<li><a href="#contact">Contact</a></li>
49+
<li><a href="#acknowledgments">Acknowledgments</a></li>
50+
</ol>
51+
</details>
52+
53+
<!-- ABOUT THE PROJECT -->
54+
## About The Project
55+
56+
This project provides a set of tools to work with mathematical expressions. It is built as a FastAPI application using the Math-MCP package.
57+
58+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
59+
60+
### Built With
61+
62+
* [![Python][Python-shield]][Python-url]
63+
* [![FastAPI][FastAPI-shield]][FastAPI-url]
64+
* [![FastAPI-MCP][FastAPI-MCP-shield]][FastAPI-MCP-url]
65+
66+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
67+
68+
<!-- GETTING STARTED -->
69+
## Getting Started
70+
71+
To get a local copy up and running follow these simple steps.
72+
73+
### Prerequisites
74+
75+
This project requires Python 3.13+ and `uv` for package management.
76+
77+
* uv
78+
```sh
79+
pip install uv
80+
```
81+
82+
### Installation
83+
84+
1. Clone the repo
85+
```sh
86+
git clone https://github.com/your_username/repo_name.git
87+
```
88+
2. Create and activate a virtual environment
89+
```sh
90+
python -m venv .venv
91+
source .venv/bin/activate
92+
```
93+
3. Install Python packages
94+
```sh
95+
uv pip install -e
96+
```
97+
98+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
99+
100+
<!-- USAGE EXAMPLES -->
101+
## Usage
102+
103+
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
104+
105+
_For more examples, please refer to the [Documentation](https://example.com)_
106+
107+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
108+
109+
<!-- ROADMAP -->
110+
## Roadmap
111+
112+
- [ ] Feature 1
113+
- [ ] Feature 2
114+
- [ ] Feature 3
115+
- [ ] Nested Feature
116+
117+
See the [open issues](https://github.com/your_username/repo_name/issues) for a full list of proposed features (and known issues).
118+
119+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
120+
121+
<!-- CONTRIBUTING -->
122+
## Contributing
123+
124+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
125+
126+
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
127+
Don't forget to give the project a star! Thanks again!
128+
129+
1. Fork the Project
130+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
131+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature''')
132+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
133+
5. Open a Pull Request
134+
135+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
136+
137+
<!-- LICENSE -->
138+
## License
139+
140+
Distributed under the MIT License. See `LICENSE` for more information.
141+
142+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
143+
144+
<!-- CONTACT -->
145+
## Contact
146+
147+
David Rodriguez - dr507498@gmail.com
148+
Faizan Khan -
149+
150+
151+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
152+
153+
<!-- ACKNOWLEDGMENTS -->
154+
## Acknowledgments
155+
156+
* [Othneil Drew's Best-README-Template](https://github.com/othneildrew/Best-README-Template)
157+
158+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
159+
160+
<!-- MARKDOWN LINKS & IMAGES -->
161+
[license-shield]: https://img.shields.io/github/license/your_username/repo_name.svg?style=for-the-badge
162+
[license-url]: https://github.com/your_username/repo_name/blob/master/LICENSE
163+
[Python-shield]: https://img.shields.io/badge/Python-3.13-3776AB.svg?style=for-the-badge&logo=python&logoColor=white
164+
[Python-url]: https://www.python.org/
165+
[FastAPI-shield]: https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi
166+
[FastAPI-url]: https://fastapi.tiangolo.com/
167+
[FastAPI-MCP-shield]: https://img.shields.io/badge/FastAPI--MCP-005571?style=for-the-badge&logo=fastapi
168+
[FastAPI-MCP-url]: https://fastapi-mcp.tadata.com/getting-started/welcome

‎pyproject.toml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[project]
2+
name = "math-mcp"
3+
version = "0.1.0"
4+
description = "Add your description here"
5+
readme = "README.md"
6+
requires-python = ">=3.13"
7+
dependencies = [
8+
"fastapi-mcp>=0.4.0",
9+
]

0 commit comments

Comments
 (0)