金融数据协议服务器

Quartr MCP Server是一个模型上下文协议服务器,提供对Quartr API的访问,用于获取金融数据和公司信息,适用于金融分析和企业研究。

  • by gaarutyunov
  • TypeScript
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 gaarutyunov/quartr-mcp

使用说明

季度 MCP 服务器

一种模型上下文协议(MCP)服务器,提供对Quartr API的访问,以获取财务数据和公司信息。

概述

此MCP服务器连接到Quartr API,以提供对以下内容的访问:

  • 上市公司信息和简介
  • 公司活动(财报电话会议、演示文稿等)
  • 财务文件(报告、成绩单、幻灯片)
  • 现场活动和音频流
  • 由人工智能驱动的文档摘要

先决条件

  • Node.js 18.0.0或更高版本
  • API季度密钥(从 API季度)

安装

选项1:自制(macOS/Linux)

使用Homebrew安装:

# First, tap the repository
brew tap gaarutyunov/quartr

# Install from source (requires Node.js)
brew install quartr-mcp-server

# Or install binary version (no Node.js required)
brew install quartr-mcp-server-bin

备注:目前公式在主存储库中。对于生产,它们将被移动到单独的tap存储库 homebrew-quartr。参见 HOMEBREW_SETUP.md 了解详情。

选项2:预构建二进制文件

从下载最新版本 发布页面:

  • macOS: index-macos
  • Linux: index-linux
  • 窗户: index-win.exe

使二进制文件可执行并移动到PATH:

# macOS/Linux
chmod +x index-macos
sudo mv index-macos /usr/local/bin/quartr-mcp-server

选项3:来源

  1. 克隆或下载此存储库
  2. 安装依赖项:
    npm install
    
  3. 构建项目:
    npm run build
    
  4. 构建为单个二进制文件(可选):
    npm run build:binary
    

配置

API密钥设置

将Quartr API键设置为环境变量:

export QUARTR_API_KEY="your-api-key-here"

MCP客户端配置

要将此服务器与Claude Desktop等MCP客户端一起使用,您需要将其添加到MCP配置文件中。

Claude桌面配置

将以下内容添加到您的Claude Desktop配置文件中:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json 视窗: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "quartr": {
      "command": "npx",
      "args": ["-y", "quartr-mcp-server"],
      "env": {
        "QUARTR_API_KEY": "your-api-key-here"
      }
    }
  }
}

与本地安装一起使用

如果您已在本地安装了服务器,则可以将其配置为从本地安装运行:

{
  "mcpServers": {
    "quartr": {
      "command": "node",
      "args": ["/path/to/quartr-mcp/build/index.js"],
      "env": {
        "QUARTR_API_KEY": "your-api-key-here"
      }
    }
  }
}

与二进制安装一起使用

如果你使用的是预构建的二进制文件:

{
  "mcpServers": {
    "quartr": {
      "command": "/usr/local/bin/quartr-mcp-server",
      "env": {
        "QUARTR_API_KEY": "your-api-key-here"
      }
    }
  }
}

与Homebrew安装一起使用

如果通过Homebrew安装:

{
  "mcpServers": {
    "quartr": {
      "command": "quartr-mcp-server",
      "env": {
        "QUARTR_API_KEY": "your-api-key-here"
      }
    }
  }
}

备注:更新配置后,重新启动Claude Desktop以使更改生效。

验证配置

要验证MCP服务器是否已正确配置和连接:

  1. 直接测试服务器:独立运行服务器以确保其启动时没有错误:

    QUARTR_API_KEY="your-api-key" npm start
    
  2. 检查克劳德桌面连接:在Claude Desktop中,您应该在开始对话时看到Quartr工具。您可以提问:“列出一些使用Quartr API的公司”或“有哪些Quartr工具可用?”

  3. 测试API连接:尝试以下简单查询:

    Use the Quartr API to find information about Apple (AAPL)
    

如果服务器连接失败,请检查:

  • 您的API密钥有效且设置正确
  • 您的互联网连接允许访问 https://api.quartr.com
  • 服务器进程具有运行的适当权限

用法

运行服务器

启动MCP服务器:

npm start

运行JavaScript包:

npm run start:binary
# or directly:
node build/index.js

运行本机可执行文件(macOS示例):

./exe/index-macos

对于自动重建的开发:

npm run dev

可用工具

服务器提供以下MCP工具:

公司

  • quartr_list_companies -列出具有筛选选项的公司
  • quartr_get_company -按ID获取详细的公司信息

事件

  • quartr_list_events -通过筛选列出公司事件
  • quartr_get_event -按ID获取详细的事件信息
  • quartr_get_event_summary -获取AI生成的事件摘要
  • quartr_list_event_types -列出可用的事件类型
  • quartr_get_event_type -按ID获取事件类型详细信息

文件

  • quartr_list_documents -列出所有经过筛选的文档
  • quartr_get_document -按ID获取文档详细信息
  • quartr_list_reports -列出财务报告
  • quartr_get_report -按ID获取报告详细信息
  • quartr_get_report_summary -获取AI生成的报告摘要
  • quartr_list_transcripts -列出电话财报会议记录
  • quartr_get_transcript -按ID获取成绩单详细信息
  • quartr_get_transcript_summary -获取AI生成的成绩单摘要
  • quartr_get_transcript_chapters -获取成绩单章节
  • quartr_list_document_types -列出可用的文档类型
  • quartr_get_document_type -按ID获取文档类型详细信息

现场活动

  • quartr_list_live_events -使用筛选功能列出实时事件
  • quartr_get_live_event -按ID获取现场活动详细信息

示例用法

以下是您可以使用此MCP服务器进行的一些示例查询:

  1. 查找Apple的公司信息:

    Use quartr_list_companies with tickers="AAPL"
    
  2. 获取公司最近的活动:

    Use quartr_list_events with companyIds="4742" and limit=5
    
  3. 获取电话财报会议的人工智能摘要:

    Use quartr_get_event_summary with id=128301 and length="short"
    
  4. 查找最近的财务报告:

    Use quartr_list_reports with documentGroupIds="3,4" and limit=10
    

过滤和分页

大多数列表端点支持按以下方式进行筛选:

  • 国家:ISO 3166-1 alpha-2国家代码(例如“美国、加利福尼亚”)
  • 交换:交易所代码(例如,“纳斯达克CM、纳斯达克GS、纽约证券交易所”)
  • 心脏:公司股票代码(例如“AAPL、AMZN”)
  • 开始日期/结束日期:ISO 8601日期范围
  • 公司Ids:特定公司ID
  • 事件Ids:特定事件ID

分页处理方式如下:

  • 限制:结果数量(最大值因终点而异)
  • 光标:下一页的分页光标
  • 方向:排序方向(“asc”或“desc”)

文档组

文件分为几组:

  • 1:收益发布
  • 2:新闻稿
  • 3:中期报告
  • 4:年度报告

现场活动状态

直播事件可以有以下状态:

  • notLive -事件未直播
  • willBeLive -活动即将上线
  • live -活动当前正在进行中
  • liveFailedInterrupted -直播中断
  • liveFailedNoAccess -无法访问直播流
  • liveFailedNotStarted -直播无法启动
  • processingRecording -正在处理录制
  • processingRecordingFailed -录制处理失败
  • recordingAvailable -录音可用

错误处理

服务器包括全面的错误处理:

  • API身份验证错误
  • 速率限制
  • 无效参数
  • 网络连接问题

错误以MCP错误响应的形式返回,并带有描述性消息。

部署

此项目支持多种部署选项:

标准Node.js部署

  • 在目标系统上需要Node.js 18+
  • 占地面积最小 dist/ 文件(~几KB)
  • 使用 npm start 运行

JavaScript捆绑包部署

  • 在目标系统上需要Node.js 18+
  • 单文件部署 build/index.js (约270KB)
  • 所有依赖项都捆绑在一起,没有 node_modules 需要
  • 使用 node build/index.js 运行

本机可执行部署

  • 目标系统上不需要Node.js
  • 独立可执行文件(~40-53MB)
  • 中的平台特定二进制文件 exe/ 目录
  • 只需直接运行可执行文件

选择最适合您的基础架构和要求的部署方法。

发展

项目结构

src/
├── index.ts          # Main MCP server implementation
├── quartr-api.ts     # Quartr API client
├── tools.ts          # MCP tool definitions and schemas
└── types.ts          # TypeScript type definitions

建筑

标准TypeScript构建:

npm run build

构建为单个JavaScript包(约270KB):

npm run build:binary

为多个平台构建本机可执行文件:

npm run build:exe

这将在中创建独立的可执行文件 exe/ 目录:

  • index-macos -macOS可执行文件(~53MB)
  • index-linux -Linux可执行文件(~48MB)
  • index-win.exe -Windows可执行文件(~40MB)

JavaScript捆绑包(build/index.js)需要运行Node.js,但要小得多。本机可执行文件是自包含的,不需要安装Node.js。

清洁

npm run clean

api参考

此服务器基于Quartr Public API v3。有关API的详细文档,请访问: https://api.quartr.com/public/v3/openapi.json

许可证

麻省理工学院

支持

对于与此MCP服务器相关的问题,请在存储库中创建问题。 有关API季度的问题,请参阅API季度的官方文档。