Skip to content

Commit da21aad

Browse files
committed
Update README.md
1 parent d4d29e3 commit da21aad

File tree

1 file changed

+17
-43
lines changed

1 file changed

+17
-43
lines changed

README.md

Lines changed: 17 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -11,54 +11,32 @@ IMAP and SMTP via MCP Server
1111
- **Github repository**: <https://github.com/ai-zerolab/mcp-email-server/>
1212
- **Documentation** <https://ai-zerolab.github.io/mcp-email-server/>
1313

14-
## Getting started with your project
14+
## Installation
1515

16-
### 1. Create a New Repository
16+
This package is available on PyPI, so you can install it using `pip install mcp-email-server`
1717

18-
First, create a repository on GitHub with the same name as this project, and then run the following commands:
18+
After that, configure your email server using the ui: `mcp-email-server ui`
1919

20-
```bash
21-
git init -b main
22-
git add .
23-
git commit -m "init commit"
24-
git remote add origin git@github.com:ai-zerolab/mcp-email-server.git
25-
git push -u origin main
26-
```
27-
28-
### 2. Set Up Your Development Environment
29-
30-
Then, install the environment and the pre-commit hooks with
31-
32-
```bash
33-
make install
34-
```
35-
36-
This will also generate your `uv.lock` file
20+
Then you can try it in [Claude Desktop](https://claude.ai/download). If you want to intergrate it with other mcp client, run `$which mcp-email-server` for the path and configure it in your client like:
3721

38-
### 3. Run the pre-commit hooks
39-
40-
Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
41-
42-
```bash
43-
uv run pre-commit run -a
22+
```json
23+
{
24+
"mcpServers": {
25+
"zerolib-email": {
26+
"command": "{{ ENTRYPOINT }}",
27+
"args": ["stdio"]
28+
}
29+
}
30+
}
4431
```
4532

46-
### 4. Commit the changes
47-
48-
Lastly, commit the changes made by the two steps above to your repository.
33+
## Development
4934

50-
```bash
51-
git add .
52-
git commit -m 'Fix formatting issues'
53-
git push origin main
54-
```
35+
This project is managed using [uv](https://github.com/ai-zerolab/uv).
5536

56-
You are now ready to start development on your project!
57-
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
37+
Try `make install` to install the virtual environment and install the pre-commit hooks.
5838

59-
To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
60-
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
61-
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
39+
Use `uv run mcp-email-server` for local development.
6240

6341
## Releasing a new version
6442

@@ -68,7 +46,3 @@ To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookie
6846
- Create a new tag in the form `*.*.*`.
6947

7048
For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).
71-
72-
---
73-
74-
Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).

0 commit comments

Comments
 (0)