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 文件。

⚠️ 免责声明

本项目仅用于教育和开发目的。请自行承担使用风险，并确保遵守相关金融法规和数据隐私要求。