Fmp MCP Server

🚀 金融建模ガイド

この金融モデリングガイドは、金融データの取得、処理、分析を行うためのサーバーアプリケーションを提供します。ユーザーはこのアプリケーションを使用して、株式データや為替データを取得し、それらのデータを分析することができます。

🚀 クイックスタート

このセクションでは、金融モデリングサーバーを起動するための手順を説明します。Docker または仮想環境を使用してインストールすることができます。

📦 インストール

Dockerを使用する場合

1. イメージを取得する：

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

2. コンテナを起動する：

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

3. パラメータの説明：

   • -it: インタラクティブモードで実行し、ターミナルを割り当てます。
   • --rm: コンテナが終了したら自動的に削除します。
   • -p 8000:8000: ポートをマッピングし、コンテナ内のサービスをホストでアクセスできるようにします。
   • -v "$PWD:/app"：現在のディレクトリをコンテナの /app パスにマウントします。

仮想環境を使用する場合

1. リポジトリをクローンする：

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

2. 仮想環境を作成してアクティブ化する（Python 3.8+ を推奨）：

   • プロジェクトのルートディレクトリで以下のコマンドを実行します：

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

   • または、poetry がインストールされている場合は、以下のコマンドを実行します：

     poetry install
     

3. 依存関係をインストールする：

   pip install -r requirements.txt
   

4. サービスを起動する：

   python main.py
   

📚 ドキュメント

設定ガイド

環境変数の設定

プロジェクトのルートディレクトリに .env ファイルを作成し、機密情報やカスタム設定を保存することをおすすめします。例えば：

# サンプルの.envファイル内容
FMP_API_KEY=your_api_key_here
OPENAI_API_KEY=your_openai_api_key_here
PORT=9000
TEST_MODE=true  # モックデータでのテスト用

起動パラメータ

コマンドライン引数を使用して、.env ファイルのデフォルト値を上書きすることができます：

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

機能モジュール

データ取得

株式データインターフェース

from fmpsdk import get_stock_data

# 例：Appleの株式の歴史データを取得する
data = get_stock_data(symbol="AAPL", api_key=api_key)
print(data.head())

為替データインターフェース

from fmpsdk import get_fx_rate

# 例：ユーロとドルの為替レートを取得する
rate = get_fx_rate(cross="EURUSD", api_key=api_key)
print(rate)

データ処理

データクリーニング

from utils.data_cleaning import clean_stock_data

# 例：株式データをクリーニングする
cleaned_data = clean_stock_data(data, fillna=True)

テストと検証

単体テスト

単体テストを実行するには：

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

統合テスト

統合テストを実行するには：

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

パフォーマンステスト

benchmark ライブラリを使用してパフォーマンステストを行います：

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)

プロジェクト構造

fmp-mcp-server/
├── main.py          # メインプログラムのエントリポイント
├── config/         # 設定ファイルと環境変数の管理
│   └── settings.py
├── data/           # データの保存と処理ロジック
│   ├── raw_data/
│   └── processed_data/
├── fmpsdk/         # サードパーティライブラリのインターフェースラッパー
│   ├── __init__.py
│   └── api.py      # APIリクエストの処理
└── tests/          # テストケース
    ├── unit_tests/
    │   └── test_api.py
    └── integration_tests/
        └── test_data_cleaning.py

コード例

基本的な使用法

from fmpsdk import get_stock_data
from utils.data_cleaning import clean_stock_data

# 株式データを取得する
data = get_stock_data(symbol="AAPL", api_key=api_key)

# データをクリーニングする
cleaned_data = clean_stock_data(data, fillna=True)
print(cleaned_data.head())

高度な使用法

from utils.technical_indicators import calculate_moving_average

# 例：単純移動平均（SMA）を計算する
sma_50 = calculate_moving_average(close_prices, window=50)
print(sma_50.tail())

CI/CDフロー

自動化テスト

1. 単体テスト：

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

2. 統合テスト：

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

3. コードカバレッジレポート：

   coverage run -m pytest tests/ && coverage report
   

自動化ビルドとリリース

1. Dockerイメージをビルドする：

   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. Docker Hubに公開する：

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

貢献ガイド

コードの提出

1. 機能ブランチを作成する：

   git checkout -b feature/new-feature
   

2. 変更をコミットする：

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

3. リモートリポジトリにプッシュする：

   git push origin feature/new-feature
   

4. メインブランチに対してPull Requestを作成する。

コンテナレジストリ

Docker Hubリポジトリ

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

ローカルでのビルドとテスト

1. イメージをビルドする：

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

2. コンテナを起動する：

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

開発規約

コードスタイル

PEP 8コーディング規約に従ってください。

バージョン管理

semver を使用してバージョン管理を行います：

• メジャーバージョン：重大な機能更新または互換性のない変更。
• マイナーバージョン：新機能の追加または改善。
• パッチバージョン：エラーやバグの修正。

ドキュメント作成

ユーザーガイド

1. インストール

   • Dockerインストールドキュメント
   • 仮想環境の設定説明

2. 使用手順

   • クイックスタートガイド
   • コード例のデモ

3. 設定オプション

   • 環境変数の詳細説明
   • パラメータ設定の説明

開発ドキュメント

1. コード構造

   • プロジェクトのディレクトリ構造
   • モジュールの機能説明

2. インターフェース定義

   • サードパーティライブラリのAPIドキュメント
   • カスタム関数のインターフェース説明

3. テストケース

   • 単体テストの方法
   • 統合テストの戦略

🔧 技術詳細

質問とサポート

質問の投稿

github リポジトリのページでIssuesを投稿してください： https://github.com/cdtait/fmp-mcp-server/issues

お問い合わせ

• メール：support@fmp-mcp-server.com
• ソーシャルメディアのリンク