FrankfurterMCP 🌍💱

Welcome to the FrankfurterMCP repository! This project provides a Model Context Protocol (MCP) server for the Frankfurter API, which offers reliable currency exchange rates. Whether you're building a financial application or just need a simple currency converter, this tool will help you get accurate and up-to-date exchange rates.

Table of Contents

• Features
• Installation
• Usage
• API Endpoints
• Contributing
• License
• Support

Features

• Real-time Currency Exchange Rates: Get the latest rates from the Frankfurter API.
• MCP Compliance: Built on the Model Context Protocol for easy integration.
• Fast and Efficient: Designed for speed, making it ideal for applications that require quick responses.
• Multi-Currency Support: Convert between multiple currencies with ease.
• Simple API: Easy-to-use endpoints for developers.

Installation

To get started, you need to download and execute the latest release. You can find it here. Follow these steps:

1. Download the Release: Visit the link and download the latest version of the server.

2. Extract the Files: Unzip the downloaded file to your desired directory.

3. Run the Server: Open your terminal and navigate to the extracted folder. Execute the server using the command:

   ./frankfurtermcp
   

4. Check for Errors: Ensure there are no errors in the terminal. If everything is set up correctly, you should see a message indicating that the server is running.

Usage

Once the server is running, you can start making requests to the API. The default endpoint is http://localhost:8080.

Example Request

To get the current exchange rate from USD to EUR, you can use the following curl command:

curl http://localhost:8080/exchange/USD/EUR

Example Response

You will receive a JSON response similar to this:

{
  "base": "USD",
  "target": "EUR",
  "rate": 0.85,
  "date": "2023-10-01"
}

API Endpoints

1. Get Exchange Rate

• Endpoint: /exchange/{base}/{target}
• Method: GET
• Description: Fetches the exchange rate from the base currency to the target currency.

2. List Supported Currencies

• Endpoint: /currencies
• Method: GET
• Description: Returns a list of all supported currencies.

3. Historical Rates

• Endpoint: /historical/{base}/{target}/{date}
• Method: GET
• Description: Retrieves the exchange rate for a specific date.

Contributing

We welcome contributions! If you want to improve this project, please follow these steps:

1. Fork the Repository: Click the fork button on the top right of this page.

2. Clone Your Fork: Use the following command to clone your fork to your local machine:

   git clone https://github.com/YOUR_USERNAME/frankfurtermcp.git
   

3. Create a Branch: Create a new branch for your feature or fix:

   git checkout -b feature-name
   

4. Make Changes: Implement your changes and test them.

5. Commit Your Changes: Use clear commit messages:

   git commit -m "Add feature"
   

6. Push to Your Fork: Push your changes back to your fork:

   git push origin feature-name
   

7. Create a Pull Request: Go to the original repository and click on "New Pull Request".

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

If you have any questions or need support, feel free to open an issue in the repository. You can also check the Releases section for updates and new features.

Topics

This repository covers various topics related to currency conversion and finance:

• currency-converter
• currency-exchange-rates
• fastmcp
• finance
• frankfurter-api
• mcp
• mcp-composition
• mcp-server
• model-context-protocol
• model-context-protocol-server

Conclusion

Thank you for visiting the FrankfurterMCP repository! We hope this project helps you in your currency conversion needs. Don't forget to check the Releases section for the latest updates.