UnusualWhales MCP 服务器

关键词

Model Context ProtocolLLM context backendresource managementtool registryprompt rendering

使用说明（Markdown 格式）

  • 项目简介

    • 该仓库实现了一个基于 Model Context Protocol（MCP）的服务器端，用于向 LLM 客户端提供上下文信息、资源数据、工具接口和提示模板的管理与渲染。服务器会将资源、工具、Prompts 统一注册进 MCP 服务，通过 JSON-RPC 进行请求与响应。

  • 主要功能点

    • 资源管理：托管和提供可访问的数据资源（Resources），方便 LLM 进行数据读取。
    • 工具注册与执行：注册并执行 Tools，LLM 可以调用外部功能，获取结构化结果。
    • 提示模板渲染：定义并渲染 Prompt 模板，支持可定制的交互模式。
    • JSON-RPC 通信：服务器通过 MCP 的标准通信规范与客户端对接，返回 JSON-RPC 风格的响应。
    • 会话管理与能力声明：支持对话会话、能力声明，以及对客户端能力的描述。
    • 多传输支持：设计上支持多种传输协议（如 Stdio、SSE、WebSocket），便于不同环境集成。
    • 安全与扩展性：在资源、工具、Prompts 的注册与调用中具备权限/错误处理的考虑，便于扩展。

  • 安装与运行

    • 使用方式通常通过 MCP 客户端（如 Claude）连接并启动服务。仓库提供的做法包括使用 npx 直接运行服务器。一个常见的启动方式是通过客户端的集成命令来启动服务器：
      • npx -y @erikmaday/unusual-whales-mcp
    • 启动前请确保环境变量中设置了 UW_API_KEY（Unusual Whales API Key），以便服务器能够访问数据源。

  • 服务器配置（JSON 格式，供 MCP 客户端配置使用）

    • 配置字段通常包括服务器名称、启动命令及参数、以及环境变量。示例配置如下（请按实际 API Key 替换占位符）： { "serverName": "unusual-whales", "command": "npx", "args": ["-y", "@erikmaday/unusual-whales-mcp"], "env": { "UW_API_KEY": "your_api_key" } }
    • 配置要点说明：
      • serverName：服务器名称，需与服务器实现中的名称一致，客户端用于识别对应的 MCP 服务器。
      • command/args：服务器启动所需的命令及参数，示例中使用 npx 启动 MCP 服务。
      • env：必要的环境变量，这里至少需要 UW_API_KEY，用于连接数据源。

  • 基本使用方法

    • 启动后，使用支持 MCP 的客户端（如 Claude 的 MCP 客户端、或任意兼容 MCP 的应用）连接该服务器。
    • 客户端可以通过 MCP 协议向服务器请求资源读取、调用工具、获取并渲染提示模板等功能，并接收 JSON-RPC 风格的响应。
    • 通过服务器暴露的工具与提示，LLM 可以实现复杂的上下文驱动推理与交互。

  • 运行与开发提示

    • 确认 Node/TS 运行环境就绪，安装依赖后即可运行源码（通常通过构建输出或直接用 MCP 客户端的运行命令启动）。
    • 如需本地调试，可针对 src/index.ts 的入口点进行调试，验证工具、资源、Prompts 的注册与响应流程。

  • 额外信息

    • 服务器实现中包含对工具、资源、Prompts 的注册流程，以及对响应结构的处理逻辑，确保与 MCP 客户端的交互符合期望的格式与行为。
    • 如需对接其他数据源或扩展更多工具，只需在 src/tools 目录中添加相应工具定义及实现，并在 src/tools/index.ts 中注册即可。

服务器信息

访问项目