MCP Server Flomo Python

🚀 Flomo Web Server and Command - Line Tool Based on MCP Protocol

This project provides a Web server and a command - line tool based on the MCP (Model Context Protocol) for interacting with the Flomo API. It aims to facilitate adding notes to Flomo and enable usage in different environments.

🚀 Quick Start

This project offers a convenient way to interact with Flomo. You can install it via PyPI or from source code, then configure and use it according to your needs.

✨ Features

• Web Server: Provides RESTful APIs to interact with Flomo.
• Command - Line Tool: Allows you to operate Flomo directly from the command line.

📦 Installation

Install from PyPI (Recommended)

# Install the basic package
pip install mcp-server-flomo

# Install development dependencies (Optional)
pip install mcp-server-flomo[dev]

Install from Source Code

git clone https://github.com/yourusername/mcp-server-flomo-python.git
cd mcp-server-flomo-python
pip install -r requirements.txt

📚 Documentation

Project Structure

.
├── flomo_cli.py         # Main entry script for the command - line tool
├── flomo_server.py      # Main entry script for the Web server
├── src                  # Source code directory
│   ├── cli              # Command - line tool module
│   │   ├── __init__.py
│   │   ├── __main__.py  # Main implementation of the CLI program
│   │   └── commands.py  # Define specific commands
│   ├── server           # Web server module
│   │   ├── __init__.py
│   │   ├── __main__.py  # Main implementation of the server
│   │   └── app.py       # Flask - based application implementation
│   └── utils            # Utility function module
│       ├── __init__.py
│       ├── config.py    # Configuration management tool
│       └── flomo_client.py  # Implementation of the Flomo API client
├── tests                # Test case directory
└── docs                 # Documentation directory

Configuration Guide

1. Create a .env file in the project root directory:

FLOMO_API_URL=https://flomoapp.com/iwh/yourID/yourAPIKey/

⚠️ Important Note

The FLOMO_API_URL is a required configuration and can be obtained from the "Settings > API" page on the Flomo official website.

Usage Examples

Basic Usage of Command - Line Tool

# Test the connection status
flomo-cli test

# Send a note to Flomo
flomo-cli send "Today is a nice day"

# Read content from a file and send it to Flomo
flomo-cli file path/to/note.txt

Basic Usage of Web Server

flomo-server run

By default, the Web server will run on http://localhost:12345 and provide the following interfaces:

• /test: Test the connection status.
• /send: Send a note to Flomo.
• /file: Read content from a specified file and send it to Flomo.

Development Guide

Install Dependencies

pip install -r requirements.txt
pip install black pytest mypy

Run Tests

pytest tests/

Code Formatting

black .

Type Checking

mypy src/

Troubleshooting

1. Cannot connect to the Flomo API:

   • Ensure that the FLOMO_API_URL configuration is correct.
   • Check the network connection to ensure that external services can be accessed.

2. Port is occupied:

   • If flomo-server run prompts that the port is occupied, try using a different port number:

     flomo-server run --port 12346
     

3. Permission issues:

   • Ensure that the user running the program has permission to access the required files and network resources.

Contribution Guide

Submit Code

1. Create a branch for feature development:

   git checkout -b feature/new - feature - name
   

2. After completing the code modification, commit it to the branch and push it to the remote repository:

   git add .
   git commit -m "Add new feature: description"
   git push origin feature/new - feature - name
   

3. Submit a Pull Request to the main branch and conduct a code review within the team.

Report Issues

If you find any issues, please submit them in the following way:

1. Create a new issue in GitHub Issues.
2. Provide detailed error information and reproduction steps.

📄 License

This project is licensed under the MIT License. The specific content is as follows:

MIT License

Copyright © [Year] [Name or Organization Name]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

With the above documentation, you can easily install, configure, and use this project. If you encounter any problems during use, please refer to this guide at any time or contact the development team for help.