使用说明

项目简介

本项目是一个 MCP (Model Context Protocol) 服务器,旨在为大型语言模型 (LLM) 应用提供访问纽约时报新闻文章搜索功能的接口。通过此服务器,LLM 可以调用预设的工具来检索最新的新闻资讯,从而增强其上下文理解和信息获取能力。

主要功能点

  • 文章搜索工具: 提供 'search_articles' 工具,允许用户通过关键词搜索近 30 天的纽约时报文章。
  • 实时新闻数据: 集成纽约时报 API,确保检索结果的时效性和准确性。
  • MCP 协议支持: 完全遵循 MCP 协议,易于与各种 MCP 客户端集成,如 Claude Desktop。
  • 易于部署: 提供详细的安装和配置指南,支持手动和通过 Smithery 自动安装。

安装步骤

  1. 克隆仓库: 将 GitHub 仓库克隆到本地:
    git clone https://github.com/angheljf/nyt
    cd nyt
  2. 安装依赖: 使用 npm 安装项目依赖:
    npm install
  3. 配置 API 密钥:
    • 在项目根目录下创建 '.env' 文件。
    • 在 '.env' 文件中添加您的纽约时报 API 密钥。您需要在 纽约时报开发者网站 注册并获取 API 密钥。
      NYTIMES_API_KEY=your_api_key_here
  4. 构建服务器: 运行构建命令编译 TypeScript 代码:
    npm run build

服务器配置

要将此 MCP 服务器与 MCP 客户端(例如 Claude Desktop)配合使用,您需要配置客户端以连接到此服务器。以下是 Claude Desktop 的配置示例,您需要将配置添加到 'claude_desktop_config.json' 文件中。

配置信息 (JSON):

{
  "mcpServers": {
    "nyt": {
      "command": "node",
      "args": ["path/to/your/nyt/build/index.js"],
      "env": {
        "NYTIMES_API_KEY": "your_api_key_here"
      }
    }
  }
}

参数说明:

  • 'server name': 'nyt' (服务器名称,客户端用此名称引用)
  • 'command': 'node' (启动服务器的命令,这里使用 Node.js 运行时)
  • 'args': '["path/to/your/nyt/build/index.js"]' (启动命令的参数,指向构建后的服务器入口文件。请将 'path/to/your/nyt' 替换为您的项目实际路径)
  • 'env': '{ "NYTIMES_API_KEY": "your_api_key_here" }' (环境变量配置,用于传递纽约时报 API 密钥。请确保 '.env' 文件中的密钥与此处配置的密钥一致,或者直接在此处替换 'your_api_key_here' 为您的实际 API 密钥)

注意:

  • 请根据您的实际项目路径修改 'args' 中的文件路径。
  • 确保 'NYTIMES_API_KEY' 环境变量已正确配置。

基本使用方法

  1. 启动服务器: 在项目根目录下,运行以下命令启动 MCP 服务器:

    node build/index.js

    服务器将在标准输入/输出 (stdio) 上监听 MCP 客户端的请求。

  2. 配置 MCP 客户端: 根据上述 “服务器配置” 部分,配置您的 MCP 客户端(如 Claude Desktop),确保客户端能够连接到正在运行的 NYTimes MCP 服务器。

  3. 在 MCP 客户端中使用工具: 在 MCP 客户端中,您可以使用 'search_articles' 工具来搜索纽约时报的文章。例如,在 Claude Desktop 中,您可以指示 Claude 使用 'nyt' 服务器的 'search_articles' 工具,并提供关键词进行搜索。

    例如,您可以向 Claude 提问: “使用 nyt 服务器的 search_articles 工具搜索关于 climate change 的新闻文章”。 Claude 接收到指令后,会调用配置的 NYTimes MCP 服务器,并使用 'search_articles' 工具和关键词 "climate change" 进行搜索,最终将搜索结果返回给您。

通过以上步骤,您就可以成功安装、配置和使用 NYTimes Article Search MCP 服务器,为您的 LLM 应用提供强大的新闻搜索能力。

信息

分类

网页与API