Metadata-Version: 2.4
Name: algogene-mcp-server
Version: 0.1.7
Summary: Algogene MCP Server - A Python package for MCP server functionality
Author-email: ALGOGENE <support@algogene.com>
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.31.0
Requires-Dist: mcp-server>=0.1.0

# ALGOGENE MCP Server

## Introduction

The `algogene_mcp_server` provides a Python-based interface for accessing the ALGOGENE API, enabling users to conduct strategy backtest, real-time data analytics, and manage trading activities.


## Installation

1. **Set Up Your Environment:**

Ensure you have Python 3.11 or later installed.



2. **Install Dependencies:**

```
pip install requests mcp-server
```


3. **Install Package:**

```
pip install algogene-mcp-server
```


4. **Update Configuration:**
Modify the configuration file located at `/config/__init__.py`.

```python
BASE_URL = "https://algogene.com/rest"

ALGOGENE_USER = "YOUR_ALGOGENE_USER_ID"
ALGOGENE_API_KEY = "YOUR_ALGOGENE_API_KEY"
```



## Running the Server
1. Start the Server:

```
python main.py
```

You can customize options using command-line arguments:

```bash
python main.py --transport streamable-http --port 8080 --host 0.0.0.0
```

2. Connect and Execute Commands:

- The server runs in STDIO mode by default. You can connect to it via your MCP client and run commands based on available tools.


## Tools Overview
1. Contract Specification:
- get_instruments: Get all available instruments available on ALGOGENE
- get_instrument_meta: Get contract specification of a financial instrument
- search_instrument: Search related financial instruments based on matched keywords of symbol or description
- list_econs_series: List out all available economic time series
- search_econs_series: Search related economic time series based on matched keywords of titles, geo and freq
- get_econs_series_meta: Get meta data or specification of an economic time series

2. Real-time Data:
- get_realtime_prices: Get current price for trading symbol(s)
- get_realtime_price_24hrchange: Get the recent 24 hours market price change
- get_realtime_exchange_rate: Get current exchange rate between 2 currencies
- get_realtime_news: Get latest news for a specified language/source/categroy
- get_realtime_weather: Get latest weather info for a specified region
- get_realtime_econs_calendar: Get the upcoming economic calendar info such as holiday, statistics release, president speech, etc
- get_realtime_econs_stat: Get the most recent released economic statistics

3. Historical Data:
- get_history_price: Get historical market price
- get_history_news: Get historical news
- get_history_weather: Get historical weather
- get_history_corp_announcement: Get company's corporate announcement history
- get_history_econs_calendar: Get economic calendar history, such as holiday, statistics release, president speech, etc
- get_history_econs_stat: Get historical released economic statistics
- strategy_market_perf: Get performance statistics for a market index 
- strategy_logs: Get system logs for running backtest or live strategy 

4. Trading Account Current Status:
- get_session: Get session token that will be used to access account and order related resources
- list_accounts: List out all your trading accounts with latest balance on ALGOGENE.
- get_positions: Get outstanding positions of a trading account
- get_balance: Get current balance of a trading account
- get_opened_trades: Get opened trades of a trading account
- get_pending_trades: Get pending trades (or limit orders) of a trading account
- set_account_config: Trading connection setup with your personal broker/exchange account on ALGOGENE.

5. Trading Account History: 
- strategy_trade: Get transaction history of a trading account
- strategy_bal: Get daily history of account balance of a trading account
- strategy_pos: Get daily history of position of a trading account
- strategy_pl: Get daily history of cumulative profit/loss of a trading account
- strategy_cashflow: Get history of cash flow (eg. deposit, withdrawal, dividend payment, etc) of a trading account
- strategy_stats: Get performance statistics history and trading setting of a trading account

6. Order Placecment and Management: 
- open_order: Place an order on a trading account
- query_order: Query an order's details of a trading account
- update_pending_order: Update trading parameters of a pending order
- update_opened_order: Update trading parameters of an outstanding/opened order
- cancel_orders: cancel a list of unfilled limit/stop orders
- close_orders: close a list of outstanding orders

7. Strategy Development
- backtest_run: Submit a strategy script to run on ALGOGENE cloud platform
- backtest_cancel: Cancel a running backtest task
- get_task_status: Query the current status of a task on ALGOGENE (eg. backtest) 

8. Other Trading Apps available on (https://algogene.com/marketplace#app): 
- app_predict_sentiment: Give a sentiment score for a given text (eg. news, blog posts, financial reports)
- app_asset_allocation: Calculate an optimal portfolio based on given risk tolerance level.
- app_portfolio_optimizer: Calculate an optimal portfolio based on dynamic objectives and conditions, such as target return, risk tolerance, group constraints, etc
- app_portfolio_optimizer_custom: Similar to 'app_portfolio_optimizer' to calculate an optimal portfolio based on given time series data
- app_fourier_prediction: Estimate the future range (i.e. upper and lower bound) of a financial instrument based on Fourier analysis and transformation. 
- app_market_classifer: Calculate the bull-bear line and classify the market condition of a given financial instrument
- app_us_company_filing_hitory: Get the filing history's report URL from US SEC for a given ticker
- app_us_company_financials: Get company financial data for a given US stock 
- app_stock_tagger: Identify related stocks for a given news
- app_index_composite: Get the index constituent data including the composited stocks, current weighting and sensitivity
- app_pattern_recoginer: Identify key technical pattern for a given financial instrument and time frame
- app_risk_analysis: Analyze potential market risk for a given portfolio holding
- app_trading_pair_aligner: Identify the most suitable instrument within the same asset class that can form a trading pair based on a given instrument
- app_price_simulator: Generate a financial time series based on correlation of another given time series
- app_capitalflow_hkex_szse: Get capital flow historical data between Hong Kong Stock Exchange (HKEx) and Shenzhen Stock Exchange (SZSE) 
- app_capitalflow_hkex_sse: Get capital flow historical data between Hong Kong Stock Exchange (HKEx) and Shanghai Stock Exchange (SSE)
- app_performance_calculator: Calculate investment performance statistics based on given NAV time series
- app_algo_generator: Generate a backtest script of trading algorithm according to user's trading ideas or description



## Demo Video

- https://algogene.com/community/post/382
- https://www.youtube.com/watch?v=M_mrO8EPrdY



## License and Terms of Use

It is an official python package developed by ALGOGENE. Read our terms of use before deploying this MCP services: https://algogene.com/terms



## Support

For new features request or bugs reporting, please contact us at support@algogene.com

