pbs-mcp-server

🚀 药剂师福利计划 (PBS) API 文档

本项目提供了关于如何使用 PBS 数据 API 的详细指南，涵盖配置、认证和示例用法等方面，帮助开发者顺利接入并使用该 API。

🚀 快速开始

在使用 PBS API 前，需完成依赖项的安装与运行，并进行环境变量的配置。同时，要获取订阅密钥以完成认证，从而正常访问 API。

✨ 主要特性

• 提供详细的配置指南，确保开发者能正确设置运行环境。
• 清晰的认证步骤，帮助开发者获取访问 API 的权限。
• 给出多种示例用法，方便开发者快速上手。
• 明确 API 的使用限制，让开发者了解使用边界。
• 提供丰富的额外资源，便于开发者进一步探索。

📦 安装指南

在开始使用 PBS API 之前，请确保安装并运行以下依赖项：

• Node.js（推荐版本 14.0 或更高）
• npm（推荐版本 6.0 或更高）

环境变量配置

创建一个 .env 文件，并添加以下内容：

PBS_API_SUBSCRIPTION_KEY=your-subscription-key-here

🔧 技术细节

认证

工具使用订阅密钥来访问 PBS API。请按照以下步骤获取您的订阅密钥：

1. 访问 PBS 数据 API 门户：

   • 前往 https://data-api-portal.health.gov.au/

2. 创建账户：

   • 点击“注册”以创建新账户
   • 填写详细信息并验证您的电子邮件地址

3. 订阅 PBS API：

   • 登录后，导航到“产品”部分
   • 选择“PBS 公共 API v3”产品
   • 点击“订阅”以请求访问该 API

4. 获取订阅密钥：

   • 审批完成后，进入您的个人资料
   • 导航至“订阅”或“API 密钥”部分
   • 复制您的主密钥或辅助密钥

5. 配置环境：

   • 基于 .env.example 模板创建一个 .env 文件
   • 将 your-subscription-key-here 替换为实际订阅密钥：

     PBS_API_SUBSCRIPTION_KEY=your-actual-subscription-key
     

限制

• 公共 API 被限流，每20秒仅允许一次请求（所有用户共享）
• 只能访问当前计划和过去12个月内发布的计划
• 部分端点需要提供特定参数
• API 结构和端点可能会更改

💻 使用示例

基础用法

获取 API 信息

{
  "endpoint": ""
}

获取药剂师

{
  "endpoint": "prescribers",
  "params": {
    "get_latest_schedule_only": "true",
    "limit": "10"
  }
}

📚 详细文档

额外资源

• PBS 网站
• PBS 数据网站
• PBS API 文档
• 模型上下文协议文档

📄 许可证

此项目采用 MIT 许可证，详细信息请参阅 LICENSE 文件。

❤️