使用说明

项目简介

Groq Compound MCP Server 是一个基于 Model Context Protocol (MCP) 标准构建的服务器，专门用于与 Groq 提供的模型进行交互，包括 Compound 模型。它通过 MCP 协议，以标准化的方式向 LLM 客户端提供与 Groq 模型交互的工具，例如进行需要实时信息的问题解答和执行代码等。

主要功能点

提供工具 (Tools):
- 'ask_with_realtime_information': 允许 LLM 客户端向 Groq 模型提问需要实时信息的问题，例如新闻或当前事件。
- 'ask_with_code_execution': 允许 LLM 客户端提问适合使用 Python REPL 交互的问题，例如需要中间计算或代码执行的场景。
基于 MCP 协议: 遵循 MCP 标准，易于与任何兼容 MCP 协议的 LLM 客户端集成。
使用 Groq API: 底层使用 Groq 提供的 API，需要配置 Groq API 密钥。
支持 stdio 传输: 使用标准输入输出 (stdio) 作为 MCP 服务器与客户端之间的通信协议，配置简单，易于部署。

安装步骤

安装 Node.js: 确保你的环境中安装了 Node.js (版本 >= 18.0.0)。

安装 groq-compound-mcp-server: 打开终端，使用 npm 命令进行安装：

npm install groq-compound-mcp-server

设置 Groq API 密钥: 你需要拥有 Groq API 密钥。将你的 API 密钥设置为环境变量 'GROQ_API_KEY'。例如，在 Linux/macOS 系统中，你可以在终端中使用 'export GROQ_API_KEY=你的API密钥' 命令设置。

服务器配置

MCP 服务器需要由 MCP 客户端启动和连接。你需要在 MCP 客户端的配置文件中指定服务器的启动命令和参数。以下是一个示例 'settings.json' 配置，展示了如何配置一个名为 'groq-compound' 的 MCP 服务器：

{
  "mcpServers": {
    "groq-compound": {
      "command": "npx",  // 启动命令，这里使用 npx 执行 npm 包
      "args": [         // 启动参数
        "-y",         // npx 参数，自动确认执行
        "groq-compound-mcp-server" // 要执行的 npm 包名，即 groq-compound-mcp-server
      ],
      "env": {          // 环境变量
        "GROQ_API_KEY": "YOUR_GROQ_API_KEY_HERE" // Groq API 密钥，请替换为你的实际密钥
      }
    }
  }
}

配置说明:

'server name' (groq-compound): 服务器名称，客户端用此名称引用服务器。可以自定义。
'command' (npx): 启动服务器的命令。由于 'groq-compound-mcp-server' 是一个 npm 包，通常使用 'npx' 来执行本地安装的 npm 包。如果全局安装了 'groq-compound-mcp-server'，可以直接使用 'groq-compound-mcp-server' 作为命令。
'args' (["-y", "groq-compound-mcp-server"]): 传递给启动命令的参数。
- '"-y"': 是 'npx' 的参数，用于跳过执行前的确认提示。
- '"groq-compound-mcp-server"': 是要执行的 npm 包的名称。
'env' ({"GROQ_API_KEY": "YOUR_GROQ_API_KEY_HERE"}): 设置服务器运行所需的环境变量。
- '"GROQ_API_KEY"': Groq API 密钥的环境变量名。你需要将 '"YOUR_GROQ_API_KEY_HERE"' 替换为你实际的 Groq API 密钥。

请根据你使用的 MCP 客户端的具体配置方法，将以上配置信息添加到客户端的配置文件中。

基本使用方法

启动 MCP 客户端: 配置完成后，启动你的 MCP 客户端。客户端会根据配置文件启动 'groq-compound-mcp-server'。
客户端与服务器交互: 客户端通过 MCP 协议与 'groq-compound-mcp-server' 进行通信，调用服务器提供的工具，例如 'ask_with_realtime_information' 和 'ask_with_code_execution'，从而间接使用 Groq 模型的功能。
查看输出: 服务器的运行日志和来自 Groq 模型的响应将通过 stdio 传输到 MCP 客户端。

具体如何使用这些工具，请参考 MCP 客户端的使用说明文档。客户端通常会提供界面或方式来调用已注册的 MCP 服务器及其提供的工具。

关键词