Fmp MCP Server

🚀 Financial Modeling Guide

This guide offers a comprehensive overview of financial modeling, including installation, configuration, feature modules, testing, and more. It aims to assist users in quickly getting started with financial data acquisition, processing, and analysis.

🚀 Quick Start

The project can be installed and run using Docker or a virtual environment.

📦 Installation

Using Docker

1. Pull the image:

   docker pull ghcr.io/cdtait/fmp-mcp-server:latest
   

2. Run the container:

   docker run -it --rm \
     -p 8000:8000 \
     -v "$PWD:/app" \
     ghcr.io/cdtait/fmp-mcp-server:latest
   

3. Parameter Explanation:

   • -it: Keep the interactive mode and allocate a terminal.
   • --rm: Automatically delete the container after it exits.
   • -p 8000:8000: Map the port so that the service inside the container can be accessed on the host.
   • -v "$PWD:/app": Mount the current directory to the /app path in the container.

Using a Virtual Environment

1. Clone the repository:

   git clone https://github.com/cdtait/fmp-mcp-server.git
   cd fmp-mcp-server
   

2. Create and activate a virtual environment (Python 3.8+ is recommended):

   • Run the following command in the project root directory:

     python -m venv .venv && source ./.venv/bin/activate
     

   • Or, if poetry is already installed, you can run:

     poetry install
     

3. Install dependencies:

   pip install -r requirements.txt
   

4. Start the service:

   python main.py
   

📚 Documentation

Configuration Guide

Environment Variable Configuration

It is recommended to create a .env file in the project root directory to store sensitive information and custom settings. For example:

# Example .env file contents
FMP_API_KEY=your_api_key_here
OPENAI_API_KEY=your_openai_api_key_here
PORT=9000
TEST_MODE=true  # For testing with mock data

Startup Parameters

You can override the default values in the .env file through command-line parameters:

python main.py --port 8001 --test_mode false

Feature Modules

Data Acquisition

Stock Data Interface

from fmpsdk import get_stock_data

# Example: Get historical data for Apple stock
data = get_stock_data(symbol="AAPL", api_key=api_key)
print(data.head())

Foreign Exchange Data Interface

from fmpsdk import get_fx_rate

# Example: Get the exchange rate of EUR to USD
rate = get_fx_rate(cross="EURUSD", api_key=api_key)
print(rate)

Data Processing

Data Cleaning

from utils.data_cleaning import clean_stock_data

# Example: Clean stock data
cleaned_data = clean_stock_data(data, fillna=True)

Testing and Verification

Unit Tests

Run unit tests:

pytest tests/unit_tests/ --cov --report=

Integration Tests

Run integration tests:

pytest tests/integration_tests/ --cov --report=

Performance Tests

Use the benchmark library for performance testing:

import pytest_benchmark
from fmpsdk import get_stock_data

@pytest.mark.benchmark
def test_get_stock_data(benchmark):
    benchmark(get_stock_data, symbol="AAPL", api_key=api_key)

Project Structure

fmp-mcp-server/
├── main.py          # Main program entry
├── config/         # Configuration files and environment variable management
│   └── settings.py
├── data/           # Data storage and processing logic
│   ├── raw_data/
│   └── processed_data/
├── fmpsdk/         # Third-party library interface encapsulation
│   ├── __init__.py
│   └── api.py      # API request handling
└── tests/          # Test cases
    ├── unit_tests/
    │   └── test_api.py
    └── integration_tests/
        └── test_data_cleaning.py

Code Examples

Example 1: Get and Clean Stock Data

from fmpsdk import get_stock_data
from utils.data_cleaning import clean_stock_data

# Get stock data
data = get_stock_data(symbol="AAPL", api_key=api_key)

# Clean the data
cleaned_data = clean_stock_data(data, fillna=True)
print(cleaned_data.head())

Example 2: Calculate Technical Indicators

from utils.technical_indicators import calculate_moving_average

# Example: Calculate the simple moving average (SMA)
sma_50 = calculate_moving_average(close_prices, window=50)
print(sma_50.tail())

CI/CD Process

Automated Testing

1. Unit Tests:

   pytest tests/unit_tests/ --cov --report=
   

2. Integration Tests:

   pytest tests/integration_tests/ --cov --report=
   

3. Code Coverage Report:

   coverage run -m pytest tests/ && coverage report
   

Automated Build and Release

1. Build a Docker Image:

   FROM python:3.9-slim
   
   WORKDIR /app
   
   COPY requirements.txt .
   RUN pip install --no-cache-dir -r requirements.txt
   
   COPY . .
   
   EXPOSE 8000
   
   CMD ["python", "main.py"]
   

2. Publish to Docker Hub:

   docker build -t cdtait/fmp-mcp-server:latest .
   docker push cdtait/fmp-mcp-server:latest
   

Contribution Guide

Submitting Code

1. Create a feature branch:

   git checkout -b feature/new-feature
   

2. Commit changes:

   git add .
   git commit -m "Add new feature"
   

3. Push to the remote repository:

   git push origin feature/new-feature
   

4. Create a Pull Request to the main branch.

Container Registry

Docker Hub Repository

docker pull ghcr.io/cdtait/fmp-mcp-server:latest

Local Build and Testing

1. Build the image:

   docker build -t local/fmp-mcp-server .
   

2. Run the container:

   docker run -it --rm -p 8000:8000 local/fmp-mcp-server
   

Development Specifications

Code Style

Follow the PEP 8 coding standard.

Version Control

Use semver for version management:

• Major version number: Major feature updates or incompatible changes.
• Minor version number: New features or improvements.
• Patch version number: Bug fixes or security patches.

Documentation Writing

User Guide

1. Installation

   • Docker installation documentation
   • Virtual environment configuration instructions

2. Usage Steps

   • Quick start guide
   • Example code demonstration

3. Configuration Options

   • Detailed explanation of environment variables
   • Parameter configuration instructions

Development Documentation

1. Code Structure

   • Project directory tree
   • Module function introduction

2. Interface Definition

   • Third-party library API documentation
   • Custom function interface description

3. Test Cases

   • Unit testing methods
   • Integration testing strategies

Questions and Support

Ask a Question

Submit an Issue on the github repository page: https://github.com/cdtait/fmp-mcp-server/issues

Contact Us

• Email: support@fmp-mcp-server.com
• Social media links