Global MCP Stock Server

by sakura-ku
Verified

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Integrations

  • Provides access to the MCP server through GitHub Packages as a private npm registry, allowing users to install the server from GitHub's package repository

  • Serves as the runtime environment for the MCP server, with specific support for Node.js 18 and above

  • Implements the MCP server with TypeScript, providing strict type checking for stock market data interfaces

全球 MCP 库存服务器

用于全球股票市场数据和分析的模型上下文协议 (MCP) 服务器

概述

该项目提供了一个用于访问股票市场数据的 MCP 服务器。让您的 AI 助手实时访问股票价格、图表数据、公司信息等。

什么是 MCP(模型上下文协议)?

模型上下文协议 (MCP) 是应用程序为大型语言模型 (LLM) 提供上下文的标准化方式。有关详细信息,请参阅模型上下文协议网站

功能

  • 获取实时股票报价
  • 股票历史数据和图表
  • 支持主要股票指数
  • 公司信息和财务数据
  • 使用 TypeScript 实现并进行严格类型检查

用户指南

先决条件

  • Node.js 18 及以上版本
  • npm 或 yarn

如何安装

  1. 克隆存储库:
    git clone https://github.com/sakura-ku/grobal_mcp_stock_server.git cd grobal_mcp_stock_server
  2. 安装依赖项:
    npm install
  3. 构建并运行服务器:
    npm run build npm start

如何使用

1.设置环境变量

首先,设置必要的环境变量:创建一个.env文件或复制并使用现有的.env.example文件:

# Windows PowerShellの場合 Copy-Item .env.example .env # UNIX系システムの場合 cp .env.example .env

编辑.env文件以设置所需的 API 密钥:

# 基本設定 PORT=3000 HOST=localhost NODE_ENV=development # Polygon.io APIキー (株価データ取得用) POLYGON_API_KEY=your_polygon_api_key_here # その他のAPIキー...

2.运行服务器

以开发模式启动服务器:

npm run dev

以生产模式启动服务器:

npm run build npm run start:prod

3. 如何使用 API

通过浏览器直接访问

服务器运行后,您可以通过以下 URL 在浏览器中访问股票数据:

http://localhost:3000/api/stock/price?symbol=AAPL

使用 cURL 的示例

您可以使用 cURL 从命令行检索数据:

# 株価データの取得 curl "http://localhost:3000/api/stock/price?symbol=AAPL" # 株価履歴データの取得(過去30日間) curl "http://localhost:3000/api/stock/history?symbol=AAPL&days=30"

程序使用示例

Node.js 应用程序的使用示例:

// 株価データを取得する関数 async function getStockPrice(symbol) { const response = await fetch(`http://localhost:3000/api/stock/price?symbol=${symbol}`); const data = await response.json(); return data; } // 使用例 getStockPrice('AAPL').then(data => { console.log(`現在の${data.symbol}の株価: ${data.price} ${data.currency}`); });

4. 与人工智能助手的整合

有关如何与 Claude、GPT-4 等 AI 助手集成的信息,请参阅“使用 MCP 客户端”部分。

Claude 使用示例

克劳德的提示示例:

株価を調べてください。 テスラ(TSLA)の現在の株価と、過去1週間の動向を教えてください。

AI助手响应示例

テスラ(TSLA)の株価情報は以下の通りです: 現在の株価: $248.42 USD 前日比: +$5.21 (+2.14%) 取引量: 3,421,532株 過去1週間の動向: - 7日前: $230.15 - 6日前: $232.05 - 5日前: $235.87 - 4日前: $239.14 - 3日前: $242.33 - 2日前: $243.21 - 1日前: $248.42 過去1週間で約8%の上昇トレンドを示しています。特に直近3日間で価格の上昇が加速しています。

可用工具

获取股票价格信息(get_stock_price)

获取指定股票的当前股价及相关信息。

参数:

  • symbol (字符串):股票代码(例如 AAPL、MSFT、GOOGL)

返回:

  • 股票信息(价格、波动、货币等)

与 MCP 客户端集成

要在客户端(Claude、Claude Desktop 或其他 MCP 支持的应用程序)中使用此 MCP 服务器,请创建一个 mcp.json 文件并定义 MCP 服务器。

mcp.json 定义示例

下面是使用此服务器的 mcp.json 定义的示例。将此设置添加到您的 MCP 客户端将允许您访问股票报价:

{ "servers": [ { "id": "global-stock-server", "url": "http://localhost:3000", "description": "株式市場データと分析のためのMCPサーバー", "tools": [ { "name": "get_stock_price", "description": "指定された株式銘柄の現在の株価と関連情報を取得します", "parameters": { "type": "object", "required": ["symbol"], "properties": { "symbol": { "type": "string", "description": "株式銘柄コード(例: AAPL, MSFT, GOOGL)" } } } } ] } ] }

如何在 MCP 客户端上设置

  1. 将上述 mcp.json 定义保存在您选择的位置。
  2. 打开 MCP 客户端(例如 Claude Desktop)的设置屏幕
  3. 在 MCP 设置部分中选择“添加服务器”或“导入”选项
  4. 选择您保存的 mcp.json 文件或复制并粘贴内容
  5. 保存设置并重启客户端

股票报价工具现在将在您的 MCP 客户端提示和聊天中可用。

如何在 Cursor IDE 中设置

在 Cursor IDE 中,您可以通过将 MCP 服务器设置添加到 settings.json 文件来使 AI 助手可用于您的工具。

设置程序

  1. 打开光标设置:
    • Windows/Linux: Ctrl+,
    • macOS: Cmd+,
  2. 选择“光标设置”并编辑settings.json文件。
  3. 将以下内容添加到mcpServers部分:
如果您将其作为本地项目运行(推荐):

该项目旨在本地开发和运行。最可靠的方法是通过 npm 脚本:

{ "mcpServers": { "global-stock-server": { "command": "npm", "args": ["run", "start"], "cwd": "/path/to/grobal_mcp_stock_server", "env": { "PORT": "3000", "HOST": "localhost", "NODE_ENV": "production", "STOCK_API_KEY": "your_api_key_here" } } } }

如果您在开发模式下运行:

{ "mcpServers": { "global-stock-server": { "command": "npm", "args": ["run", "dev"], "cwd": "/path/to/grobal_mcp_stock_server", "env": { "PORT": "3000", "HOST": "localhost", "NODE_ENV": "development", "STOCK_API_KEY": "your_api_key_here" } } } }
从 GitHub Packages 安装

该 MCP 服务器使用 GitHub Packages 公开为私有 npm 注册表。您可以按照以下步骤进行安装:

  1. 创建或编辑.npmrc文件来配置身份验证:
@sakura-ku:registry=https://npm.pkg.github.com //npm.pkg.github.com/:_authToken=${NPM_TOKEN}
  1. NPM_TOKEN环境变量设置为您的个人 GitHub 访问令牌:
# Windowsの場合 $env:NPM_TOKEN="your_github_token" # macOS/Linuxの場合 export NPM_TOKEN="your_github_token"
  1. 安装软件包:
npm install @sakura-ku/grobal-mcp-stock-server
  1. Cursor IDE 中的设置示例:
{ "mcpServers": { "global-stock-server": { "command": "npx", "args": ["@sakura-ku/grobal-mcp-stock-server"], "env": { "PORT": "3000", "HOST": "localhost", "STOCK_API_KEY": "your_api_key_here" } } } }

有关详细配置说明,请参阅如何管理私有 npm 注册表

故障排除

  • 如果服务器没有启动
    • 进入你的项目目录并手动运行命令来查看错误
    • 验证依赖项是否正确安装(运行npm install
    • 检查 TypeScript 版本是否正确
  • 如果找不到该工具
    • 检查服务器是否正常运行
    • 检查日志输出中注册的工具名称
    • 如果需要,使用npm run dev以调试模式运行服务器

开发者指南

项目配置

grobal_mcp_stock_server/ ├── build/ # コンパイルされたJavaScriptファイル ├── src/ │ ├── __tests__/ # 統合テストとテストユーティリティ │ ├── config/ # 設定ファイル │ ├── data/ # データモデルとストレージ │ ├── errors/ # カスタムエラークラス │ ├── services/ # 外部APIとの連携サービス │ ├── tools/ # MCPツール実装 │ │ └── __tests__/ # ツールユニットテスト │ ├── types/ # TypeScript型定義 │ └── index.ts # メインサーバーエントリーポイント ├── package.json # プロジェクト設定 ├── tsconfig.json # TypeScript設定 └── README.md # プロジェクトドキュメント

设置开发环境

  1. 安装开发依赖项:
    npm install
  2. 以开发模式启动服务器:
    npm run dev

开发工作流程

  • 以监视模式启动 TypeScript 编译器: npm run dev
  • 代码静态分析: npm run lint
  • 自动修复静态分析问题: npm run lint:fix
  • 运行测试: npm test

可用脚本

package.json中定义的脚本详细解释:

构建脚本

  • build :编译 TypeScript 代码并将其输出到 dist 目录。
  • build:dev :使用源映射构建开发环境
  • build:prod :无需源映射即可进行生产构建
  • clean :删除并清理 dist 目录
  • prebuild :在构建之前自动运行清理脚本

服务器启动脚本

  • start :启动编译的服务器
  • start:dev :使用开发环境配置启动服务器
  • start:prod :以生产配置启动服务器
  • dev :开发模式,监视源代码的变化并自动构建和重新启动。

代码质量控制脚本

  • lint :使用 ESLint 对 TypeScript 代码进行静态分析。
  • lint:fix :使用 ESLint 自动修复代码问题

测试脚本

  • test :使用 Jest 运行所有测试
  • test:watch :在监视模式下运行测试,在发生更改时重新运行
  • test:coverage :生成测试覆盖率报告
  • test:ci :使用 CI 环境的测试配置运行
  • test:unit :仅运行单元测试
  • test:integration :仅运行集成测试
  • test:services :仅运行服务测试
  • test:debug :以调试模式运行测试

部署和打包

  • deploy:staging :部署到暂存环境
  • deploy:production :部署到生产环境
  • publish:package :将包发布到 npm 注册表
  • prepare:package :在打包之前运行生产构建并创建 tarball
  • prepublishOnly :在发布包之前运行生产构建

执照

国际学习中心

贡献

如果您有兴趣为该项目做出贡献,请提交拉取请求。

-
security - not tested
F
license - not found
-
quality - not tested

通过模型上下文协议 (MCP) 服务器为 AI 助手提供对全球股票市场数据的实时访问,包括当前价格、历史图表和公司财务信息。

  1. 概要
    1. MCP(Model Context Protocol)とは
      1. 機能
        1. 利用者向けガイド
          1. 前提条件
          2. インストール方法
          3. 利用方法
          4. 利用可能なツール
          5. MCPクライアントとの連携
        2. 開発者向けガイド
          1. プロジェクト構成
          2. 開発環境のセットアップ
          3. 開発ワークフロー
          4. 使用可能なスクリプト
          5. ライセンス
          6. 貢献
        ID: fa4bwupn5s