README
🚀 股票市场 MCP 服务器
这是一个基于 TypeScript 的 MCP 服务器,主要用于获取股票市场数据。它借助 Alpha Vantage API,能为用户提供实时的股票市场信息以及公司财务数据,助力用户更好地了解股票市场动态。
🚀 快速开始
本服务器是基于 TypeScript 的 MCP 服务器,借助 Alpha Vantage API 提供实时股票市场信息和公司财务数据。以下是使用前的开发环境配置步骤。
安装依赖
npm install
构建项目
npm run build
开发模式(自动重新构建)
npm run watch
✨ 主要特性
工具
-
get_ticker_price- 获取股票实时价格- 需要提供股票代码作为参数
- 返回最新的股票价格和时间戳
-
get_market_report- 获取美国市场报告- 提供市场整体状况概览
-
get_financial_statement- 获取公司财务报表- 支持三种报表类型:收入报表(income)、资产负债表(balance)、现金流量表(cashflow)
- 需要提供股票代码和报表类型
-
get_company_overview- 获取公司概览信息- 需要提供股票代码
- 返回公司关键指标和基本信息
📦 安装指南
要在 Claude Desktop 中使用此服务器,需要添加服务器配置:
MacOS
配置文件路径:~/Library/Application Support/Claude/claude_desktop_config.json
Windows
配置文件路径:%APPDATA%/Claude/claude_desktop_config.json
配置示例:
{
"mcpServers": {
"stock-market-server": {
"command": "/path/to/stock-market-server/build/index.js"
}
}
}
💻 使用示例
基础用法
以下是使用 get_ticker_price 工具获取股票实时价格的示例:
# 假设这里是调用 get_ticker_price 的代码示例
# 这里需要根据实际情况补充调用代码
高级用法
以下是获取公司财务报表的示例,以获取收入报表为例:
# 假设这里是调用 get_financial_statement 获取收入报表的代码示例
# 这里需要根据实际情况补充调用代码
🔧 技术细节
本项目的技术栈主要包含以下几个部分:
- TypeScript:作为主要的开发语言,为项目提供了类型检查,增强了代码的可维护性和健壮性。
- Node.js:作为运行时环境,使得项目可以在服务器端运行。
- Alpha Vantage API:用于获取实时股票市场信息和公司财务数据。
- MCP SDK (@modelcontextprotocol/sdk):为项目提供了与 MCP 相关的功能支持。
📄 许可证
[添加许可证信息]
⚠️ 重要提示
- 使用前需要确保有有效的 Alpha Vantage API 密钥。
- 所有 API 响应都以 JSON 格式返回。
- 请注意 Alpha Vantage API 的调用频率限制。
微信扫一扫