Skip to content

Commit ab46a2c

Browse files
committed
Update the README.md
1 parent 258d9d4 commit ab46a2c

File tree

1 file changed

+65
-2
lines changed

1 file changed

+65
-2
lines changed

README.md

Lines changed: 65 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,65 @@
1-
# mcp-server-calculator
2-
A Model Context Protocol server for calculating.
1+
# Calculator MCP Server
2+
3+
A Model Context Protocol server for calculating. This server enables LLMs to use calculator for precise numerical calculations.
4+
5+
### Available Tools
6+
7+
- `calculate` - Calculates/evaluates the given expression.
8+
- `expression` (string, required): Expression to be calculated
9+
10+
## Installation
11+
12+
### Using uv (recommended)
13+
14+
When using [`uv`](https://docs.astral.sh/uv/) no specific installation is needed. We will
15+
use [`uvx`](https://docs.astral.sh/uv/guides/tools/) to directly run *mcp-server-calculator*.
16+
17+
```bash
18+
curl -LsSf https://astral.sh/uv/install.sh | sh
19+
```
20+
21+
### Using PIP
22+
23+
Alternatively you can install `mcp-server-calculator` via pip:
24+
25+
```bash
26+
pip install mcp-server-calculator
27+
```
28+
29+
After installation, you can run it as a script using:
30+
31+
```bash
32+
python -m mcp_server_calculator
33+
```
34+
35+
## Configuration
36+
37+
### Using uv (recommended)
38+
39+
Add this to your MCP client settings:
40+
41+
```json
42+
"mcpServers": {
43+
"calculator": {
44+
"command": "uvx",
45+
"args": ["mcp-server-calculator"]
46+
}
47+
}
48+
```
49+
50+
### Using PIP
51+
52+
Alternatively add this to your MCP client settings:
53+
54+
```json
55+
"mcpServers": {
56+
"calculator": {
57+
"command": "python",
58+
"args": ["-m", "mcp_server_calculator"]
59+
}
60+
}
61+
```
62+
63+
## License
64+
65+
mcp-server-calculator is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.

0 commit comments

Comments
 (0)