Enables configuration of the server using environment variables stored in a .env file for setting workspace paths and other parameters.
Provides tools for contributing to the TWStockMCPServer project through GitHub Issues, Discussions, and Pull Requests for bug reporting and feature suggestions.
Runs on Python 3.8+ with support for Python packages and libraries for implementing stock data analysis tools.
Displays status badges in the README for license, Python version, and MCP compatibility information.
🚀 TWStockMCPServer
一個全面的模型上下文協議 (MCP) 伺服器,專為台灣證券交易所 (TWSE) 數據分析設計,提供即時股票資訊、財務報表、ESG 數據和趨勢分析功能。
🎬 示範影片
觀看 TWStockMCPServer 功能展示
✨ 主要功能
📊 技術分析工具
- 每日交易數據:即時股價、成交量和交易統計
- 價格趨勢:每日收盤價和月平均價格計算
- 估值指標:本益比、股利殖利率和股價淨值比
- 歷史數據:月份和年度交易資訊
💰 基本面分析
- 財務報表:綜合損益表和資產負債表
- 營收報告:月營收追蹤和成長分析
- 股利資訊:配息記錄和股利政策
- 公司治理:ESG 數據和治理指標
🏛️ 市場情報
- 市場指數:即時台股指數資訊
- 法人動態:融資融券和借貸數據
- 市場統計:每日市場摘要和趨勢
🌱 ESG 與永續經營
- 氣候管理:氣候相關風險評估
- 風險管理:企業風險管理政策
- 供應鏈:供應鏈管理透明度
- 資訊安全:網路安全事件報告
⚙️ 安裝說明
使用者快速安裝
📋 完整安裝指南 - 所有平台和使用情境的詳細說明
系統需求
- Python 3.10 或更高版本
- pip 套件管理器或 uv
- Docker(可選,用於容器化部署)
快速開始
- 複製專案
- 安裝相依套件使用 pip:使用 uv(推薦):
- 設定 MCP 客戶端在您的 MCP 客戶端設定檔中新增(例如:
.vscode/mcp.json
): - 啟動伺服器開發模式(熱重載):正式環境模式:
- Docker 部署(可選)
🔧 設定
環境變數
在專案根目錄建立 .env
檔案:
相依套件
主要相依套件包括:
fastmcp
:MCP 伺服器框架requests
:HTTP 客戶端進行 API 呼叫logging
:Python 內建日誌系統
📚 可用工具
公司資訊
get_company_profile(code)
- 公司基本資訊get_company_dividend(code)
- 股利分配數據get_company_monthly_revenue(code)
- 月營收報告
交易數據
get_stock_daily_trading(code)
- 每日交易統計get_stock_monthly_average(code)
- 月平均價格get_stock_valuation_ratios(code)
- 估值指標get_stock_monthly_trading(code)
- 月交易數據get_stock_yearly_trading(code)
- 年度交易統計
財務報表
get_company_income_statement(code)
- 綜合損益表get_company_balance_sheet(code)
- 資產負債表數據
市場數據
get_market_index_info()
- 市場指數資訊get_margin_trading_info()
- 融資融券統計
ESG 與治理
get_company_governance_info(code)
- 公司治理get_company_climate_management(code)
- 氣候相關管理get_company_risk_management(code)
- 風險管理政策get_company_supply_chain_management(code)
- 供應鏈數據get_company_info_security(code)
- 資訊安全指標
🤝 參與貢獻
歡迎開發者社群參與貢獻!您可以透過以下方式協助:
貢獻方式
- 新增工具:擴展 API 覆蓋範圍,實作新的 TWSE 端點
- 改善文件:協助改進範例和說明文件
- 修復錯誤:回報和修復問題
- 功能建議:提出新功能想法
- 測試:新增測試案例和提升可靠性
開發環境設定
- Fork 專案
- 建立功能分支
- 在
server.py
中新增您的工具 - 更新說明文件
- 提交 Pull Request
API 參考
參考 staticFiles/apis_summary_simple.json
查看可實作為新工具的可用 TWSE API 端點。
程式碼風格
- 遵循 Python PEP 8 指南
- 新增完整的 docstrings
- 包含錯誤處理
- 記錄重要操作
📋 API 涵蓋範圍
目前支援 15+ TWSE API 端點,包括:
- 公司檔案和基本資訊
- 股票交易數據(每日、每月、每年)
- 財務報表和報告
- ESG 和永續指標
- 市場指數和統計
- 股利和治理資訊
🔒 資料來源
所有資料來源自台灣證券交易所 (TWSE) 官方開放 API:
- 基礎 URL:
https://openapi.twse.com.tw/v1
- 即時和歷史資料
- 無需 API 金鑰
- 適用速率限制
⚠️ 免責聲明
本軟體僅供參考之用,不構成投資建議。使用者應進行自己的研究,並在做出投資決定前諮詢財務專業人士。
📄 授權條款
本專案採用 MIT 授權條款 - 詳見 LICENSE 檔案。
🙏 致謝
- 台灣證券交易所提供開放資料 API
- MCP 社群提供協議規範
- 本專案的貢獻者和使用者
📞 支援
- 問題回報:GitHub Issues
- 討論區:GitHub Discussions
- 說明文件:Wiki
以 ❤️ 為台灣股票分析社群打造
🌏 語言版本
- English | 繁體中文
免責聲明:由於我不熟悉 Python,該專案完全由 AI 生成,然後根據需要手動調整。
This server cannot be installed
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
台灣證交所MCPServer
Related MCP Servers
- Python
- -securityAlicense-qualitySatellite Tracking MCP ServerLast updated -TypeScriptMIT License
- -securityAlicense-qualityMarineTraffic MCP ServerLast updated -1TypeScriptMIT License
- RustMIT License