🚀 MCP - FRED 使用说明文档

本工具借助模型上下文协议（MCP）连接到 FRED API，能让您轻松获取经济数据。以下将为您详细介绍它的安装、配置及使用方法。

🚀 快速开始

MCP - FRED 提供了简洁接口来访问 FRED 的数据，使用步骤如下：

1. 初始化客户端：

from mcp_fred import FredClient

client = FredClient(api_key='your_api_key_here')

2. 发送请求：

response = client.get_series_data(series_id='GDP', sort_order='desc')

3. 处理响应：

print(response.data)

✨ 主要特性

• 借助模型上下文协议（MCP）连接 FRED API，方便获取经济数据。
• 提供简洁接口，便于用户操作。

📦 安装指南

2.1 安装依赖

确保您已安装必要的库：

pip install requests

2.2 配置 API 密钥

在 FRED 官网注册并获取 API 密钥，将其添加到您的项目中以进行身份验证。

💻 使用示例

基础用法

# 初始化客户端
from mcp_fred import FredClient

client = FredClient(api_key='your_api_key_here')
# 发送请求获取数据
response = client.get_series_data(series_id='GDP')
# 处理响应
print(response.data)

高级用法

# 按降序获取 GDP 数据
response = client.get_series_data(series_id='GDP', sort_order='desc')
print(response.data)

📚 详细文档

参数详解

必填参数

• series_id (str): 数据系列的唯一标识符，如'GDP'。

可选参数

• sort_order (str, optional): 返回数据的排序方式。可选值为'desc'(降序) 或 'asc'(升序)，默认为'asc'。
• units (str, optional): 数据的单位表示，如'pch' 表示百分比变化。
• 其他参数包括：frequency, aggregation_method, output_type 等。

🔧 技术细节

MCP - FRED 通过模型上下文协议（MCP）与 FRED API 建立连接，利用 Python 的 requests 库发送 HTTP 请求获取经济数据。用户通过初始化 FredClient 并传入 API 密钥进行身份验证，然后调用 get_series_data 方法发送请求，根据传入的参数获取不同的数据系列和排序方式等。

📄 许可证

本项目遵循 MIT 许可证，具体内容请参阅 LICENSE 文件。

参考资料

• FRED API 文档
• 模型上下文协议

⚠️ 重要提示

• 确保您的 API 密钥有效且已正确配置。
• 遵循 FRED 的使用限制，如每分钟最多请求次数。

💡 使用建议

• 若遇到错误，可使用client.get_error()方法获取详细的错误信息。
• 支持的数据频率包括：'a'(年), 'm'(月), 'q'(季) 等。

如需更多信息或遇到问题，请随时查阅文档或联系支持团队。