article
README
🚀 状态投资 - MCP 服务器
该项目是模型上下文协议(MCP)生态系统的一部分,提供了与外部 API 和特定领域模型交互的工具。它展示了如何构建一个带有外部 API 集成和数据验证的 MCP 服务器,可助力用户与股票市场数据进行交互。
🚀 快速开始
本项目提供了与状态投资 API 集成的 MCP 服务器,能让 MCP 工具查询股票市场数据,如股票价格、指标和支付日期等。
✨ 主要特性
- 多样化数据获取:
- get-acoes:获取基本股票信息。
- get-indicadores:获取详细股票指标信息。
- get-acoes-datas-pagamento:获取股票支付日期。
- 数据验证:使用 Zod 进行输入验证,确保数据的准确性。
- API 集成:使用
fetch集成状态投资 API(基础设施层)。
🔧 技术细节
架构
本项目遵循分层架构,灵感源自领域驱动设计(DDD)模式:
- 领域 (
src/domain):定义表示数据结构的接口和类型(例如,StatusInvest)。 - 基础设施 (
src/infrastructure):实现外部服务,如StatusInvestApiService,负责向状态投资 API 发出 HTTP 请求。 - 应用层 (
src/application):包含业务逻辑,在StatusInvestService中处理和格式化来自基础设施的数据。 - 接口 (
src/interface):包括控制器(StatusInvestToolsController),用于在 MCP 服务器中注册工具,定义验证模式并返回结果。 - 入口点 (
src/main.ts):初始化McpServer,配置传输(StdioServerTransport),实例化服务和控制器,并开始侦听标准输入输出。
文件结构
src/
├── domain/
│ └── models/ # 领域接口
├── infrastructure/
│ └── services/ # 外部 API 实现(状态投资)
├── application/
│ └── services/ # 业务逻辑和数据格式化
├── interface/
│ └── controllers/ # MCP 工具注册和验证
└── main.ts # 服务器入口点
build/ # 编译后的 JavaScript 代码
.vscode/ # 包含 mcp.json 文件,MCP 服务器配置
📦 安装指南
git clone git@github.com:newerton/mcp-status-invest.git
cd mcp-status-invest
npm install
npm run build
📚 详细文档
VSCode 中的 MCP 服务器配置
- 打开终端并运行以下命令:
npm install -g npm - 在 VSCode 中,打开“终端”并执行以下命令:
npm install -D @types/node typescript jsconfig.json
VSCode 中的 MCP 服务器输出
// 配置语言模式为 JavaScript 或 TypeScript
🤝 贡献
欢迎 fork 和 pull request!请在提交之前阅读贡献指南。
📄 许可证
该项目受 MIT License 保护。
微信扫一扫