FlyMoon 0.1.1

FlyMoon Python Package for MCP (Mission Control Protocol) clients

MCP Server Client

A Python client library for interacting with the MCP Server. This library provides a simple wrapper around the MCP Server API to register agents, move them around, and observe the environment.

Table of Contents

• Installation
• Usage
  • Basic Usage
  • Automated Agent Loop
• API Reference
• Project Structure
• Example Agent
• Troubleshooting
• Contributing
• License

Installation

Option 1: Install from PyPI (Recommended)

pip install flymoon

Option 2: Install from Source

1. Clone this repository:

git clone https://github.com/Tanishqpy/FlyMoon
cd FlyMoon
pip install -e .

2. Install the required dependencies:

pip install -r requirements.txt

3. (Optional) Create a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Usage

Basic Usage

from flymoon import MCPClient

# Create a client instance
client = MCPClient(
    server_url="http://localhost:8000",
    agent_id="explorer_bot",
    agent_type="scout"
)

# Register the agent
registration_result = client.register()
print(f"Registration result: {registration_result}")

# Move the agent
move_result = client.move(x=10, y=5)
print(f"Move result: {move_result}")

# Observe surroundings
observation = client.observe()
print(f"Observation: {observation}")

Automated Agent Loop

The client also includes a simple automation function:

# Run a simple agent loop (5 steps by default)
client = MCPClient(agent_id="explorer_bot", agent_type="scout")
client.run_simple_loop(steps=5, delay=1)

API Reference

MCPClient

Constructor

• MCPClient(server_url="http://localhost:8000", agent_id=None, agent_type=None)

Methods

• register(agent_id=None, agent_type=None): Register an agent with the server
• move(x, y): Move the agent to the specified coordinates
• observe(): Observe the surroundings
• run_simple_loop(steps=5, delay=1): Run an automated agent loop

Project Structure

• mcp_client.py: Main client library class
• agent_client.py: Example implementation without using the wrapper
• main.py: FastAPI server implementation
• mcp_env.py: Environment definition and functionality
• launch_mcp.sh: Script to start the server with ngrok tunneling
• requirements.txt: Project dependencies

Example Agent

See agent_client.py for a simple example of directly using the API without the wrapper.

Troubleshooting

Common Issues

1. Connection refused errors

   • Make sure the MCP server is running on the specified port
   • Check if the server URL is correct
   • Verify network connectivity

2. Authentication failures

   • Ensure you're using a valid agent_id
   • Try re-registering your agent

3. Movement limitations

   • Agents can't move outside the environment boundaries
   • Check observation results for valid movement ranges

Server Setup

To start the server locally:

# Start the FastAPI server
uvicorn main:app --reload

# Or use the provided launch script
./launch_mcp.sh

Contributing

Contributions are welcome! Here's how you can contribute:

1. Fork the repository
2. Create a new branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Commit your changes (git commit -m 'Add some amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a Pull Request

Please make sure to update tests as appropriate.

License

MIT License

Copyright (c) 2025 Tanishq

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.