🚀 纽约时报 MCP 服务器
本项目是一个统一的消息汇聚协议 (MCP) 服务器，它提供了与纽约时报（NYT）各种 API 的简单统一接口。借助该服务器，用户能够通过单个端点轻松与多个 NYT API 进行交互，极大地简化了操作流程。
🚀 快速开始
环境准备
- 确保你已安装 Python 3.8 或更高版本。
- 前往 NYT 开发者门户 获取 NYT API Key。
- 安装必要的 Python 包，具体可查看
requirements.txt文件。
操作步骤
- 克隆仓库：
git clone https://github.com/your-username/nyt-mcp-server.git
cd nyt-mcp-server
- 创建并激活虚拟环境：
python -m venv venv
source venv/bin/activate # Windows 系统请使用：venv\Scripts\activate
- 安装依赖项：
pip install -r requirements.txt
- 创建
.env文件：
NYT_API_KEY=your_api_key_here
MCP_PORT=8000
MCP_HOST=0.0.0.0
- 运行服务器：
python src/server.py
✨ 主要特性
- 单一端点：通过一个一致的接口即可访问所有 NYT API，无需分别对接多个 API，提高开发效率。
- 清晰响应：对 API 响应进行格式化和简化处理，让数据呈现更加清晰易懂。
- 实时更新：借助时报新闻功能，能够实时获取新闻 feed，紧跟时事动态。
- 灵活搜索：具备全面的文章搜索功能，可根据关键词或标题精准查找相关文章。
- 错误处理：拥有强大的错误管理机制，保障系统稳定运行。
- 健康监测：内置健康检查端点，方便随时了解服务器的运行状态。
- 易于集成：简单易行的集成方式，适用于任何应用程序，降低开发成本。
📦 安装指南
环境要求
- Python 3.8+
- NYT API Key（在 NYT 开发者门户 获取）
- 必要的 Python 包（见
requirements.txt）
安装步骤
按照快速开始部分的操作步骤进行安装即可。
💻 使用示例
基础用法
文章搜索
{
"operation": "search",
"parameters": {
"query": "example"
}
}
高级用法
健康检查
GET /health
📚 详细文档
项目结构
nyt-mcp-server/
├── src/
│ ├── __init__.py
│ ├── server.py
│ └── config.py
├── .env
├── .gitignore
├── requirements.txt
└── README.md
API 文档
基础 URL
http://localhost:8000
端点
- POST /mcp：用于执行各种操作，如文章搜索等。示例请求体如下：
{
"operation": "search",
"parameters": {
"query": "example"
}
}
- GET /health：用于检查服务器的健康状态。
消息类型
- 文章搜索：通过关键词或标题查找相关文章。
- 热门故事：获取当前最热门的故事列表。
- 时报新闻：实时更新的新闻 feed。
- 最受欢迎的内容：查看用户浏览量最高的内容。
- 存档：访问历史文章和旧闻。
- 图书 API：查询书籍信息和库存状态。
🔧 技术细节
此 MCP 服务器充当多个纽约时报 API 的统一网关，涵盖了文章搜索、热门故事、时报新闻（实时新闻）、最受欢迎的内容、存档和图书 API 等多个方面。它通过单一端点简化了与多个 API 的交互，为用户提供了便捷的使用体验。
📄 许可证
本项目采用 MIT License。
⚠️ 重要提示
- 永远不要提交
.env文件，避免敏感信息泄露。 - 务必保持 NYT API Key 的私密性，防止被他人滥用。
- 建议使用环境变量存储敏感数据，提高数据安全性。
💡 使用建议
如果在使用过程中遇到问题或有功能需求，可通过创建问题报告错误或提出功能请求。
🤝 贡献指南
- 叉取仓库。
- 创建功能分支（
git checkout -b feature/AmazingFeature）。 - 提交更改（
git commit -m 'Add some AmazingFeature'）。 - 推送到分支（
git push origin feature/AmazingFeature）。 - 打开 Pull Request。