MCP Sigmund

🚀 MCP Sigmund

MCP Sigmund 是一款用於金融數據分析與學習的模型上下文協議（MCP）服務器，它採用統一的 PostgreSQL 數據庫作為主要數據源。具備智能格式化和漸進式展示功能，能為用戶帶來絕佳體驗。

⚠️ 重要法律聲明

MCP Sigmund 是一個教育學習資源和數據分析工具，並非金融顧問或諮詢服務。

🚫 非金融建議

• 本系統不提供金融建議、推薦或指導。
• 所有見解、分析和建議僅用於教育目的。
• 用戶必須基於自身研究和判斷做出財務決策。
• 本系統的任何信息都不應被視為投資、稅務或財務建議。

📚 僅用於教育目的

• MCP Sigmund 旨在作為理解個人財務數據的學習資源。
• 該系統幫助用戶分析和理解其財務模式和趨勢。
• 所有輸出均用於教育和信息目的。
• 用戶應諮詢合格的金融專業人士以獲取實際的財務建議。

使用 MCP Sigmund 即表示您認可這是一個教育工具，而非金融諮詢服務。

🚀 快速開始

安裝完成後，您可以使用以下基本查詢來開始使用 MCP Sigmund：

• “Show me my balance” —— 獲取當前賬戶餘額。
• “List my recent transactions” —— 查看近期交易記錄。
• “Analyze my spending” —— 按類別進行支出分析。
• “What providers do I have?” —— 列出已連接的銀行服務提供商。

有關詳細的使用說明、示例和高級功能，請參閱用戶指南。

✨ 主要特性

• 🗄️ 數據庫驅動 —— 使用 PostgreSQL 數據庫作為主要數據源，存儲標準化的銀行數據。
• 🏦 多提供商支持 —— 整合來自多個開放銀行數據源（銀行和聚合商）的數據。
• 🎯 智能格式化 —— 智能默認設置和漸進式展示，優化用戶體驗。
• 🔄 上下文檢測 —— 根據用戶意圖自動調整格式。
• 🌐 全提供商默認 —— 未指定提供商時，默認查詢所有提供商。
• 🛡️ 全面的錯誤處理 —— 強大的驗證和錯誤管理。
• ✅ 完整的測試覆蓋 —— 進行單元測試和集成測試，確保可靠性。
• 📝 TypeScript 支持 —— 支持類型安全的開發，具備全面的類型定義。
• 🔐 安全配置 —— 集中式認證系統，保護憑證安全。
• 🔒 安全特性 —— 密碼清理、輸入驗證和安全日誌記錄。
• 📊 結構化日誌記錄 —— 全面的日誌記錄，包含上下文和錯誤跟蹤。
• ⚡ 性能監控 —— 跟蹤查詢性能和系統健康狀況。

📦 安裝指南

1. 克隆此倉庫：

git clone <repository-url>
cd mcp-sigmund

2. 安裝依賴項：

npm install

3. 設置數據庫：

   選項 A：從數據庫轉儲文件導入（推薦）

   # 創建數據庫
   createdb mcp-sigmund
   
   # 導入提供的數據庫轉儲文件
   psql -d mcp-sigmund -f mcp-sigmund-dump.sql
   

   選項 B：使用現有數據庫

   • 確保您的 PostgreSQL 數據庫包含所需的架構（請參閱數據庫文檔）。
   • 更新配置中的連接字符串。

4. 配置數據庫連接：

   • 將 src/auth.example.ts 複製為 src/auth.ts。
   • 更新 src/auth.ts 中的 PostgreSQL 連接字符串：

     connectionString: "postgresql://username:password@host:port/database"
     

   • 根據需要調整連接池設置。

5. 構建項目：

npm run build

6. 運行測試以驗證一切正常：

npm test

📚 詳細文檔

• 用戶指南 —— 完整的用戶指南，包含配置、工具和示例。
• 開發指南 —— 開發者文檔、測試和貢獻指南。
• 數據庫文檔 —— 數據庫設置、架構和導入說明。
• 路線圖 —— 未來開發計劃和功能路線圖。
• 下一步 —— 立即執行的操作項和實施細節。

📄 許可證

本項目採用 ISC 許可證，詳情請參閱 LICENSE 文件。

⚠️ 免責聲明

本項目僅用於教育和開發目的。請自行承擔使用風險，並確保遵守相關金融法規和數據隱私要求。