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 文件。

❤️