Pbs MCP Server

🚀 Pharmacy Benefits Scheme (PBS) API Documentation

This document provides a detailed guide on how to use the PBS Data API, including configuration, authentication, and example usage.

🚀 Quick Start

✨ Features

This API allows users to access PBS data with proper configuration and authentication. It provides endpoints to get API information and retrieve prescriber data, subject to certain limitations.

📦 Installation

Before you start using the PBS API, make sure you have the following dependencies installed and running:

• Node.js (Recommended version 14.0 or higher)
• npm (Recommended version 6.0 or higher)

Environment Variable Configuration

Create a .env file and add the following content:

PBS_API_SUBSCRIPTION_KEY=your-subscription-key-here

🔧 Technical Details

Authentication

The tool uses a subscription key to access the PBS API. Follow these steps to obtain your subscription key:

1. Access the PBS Data API Portal:
   • Go to https://data-api-portal.health.gov.au/
2. Create an Account:
   • Click "Register" to create a new account.
   • Fill in the details and verify your email address.
3. Subscribe to the PBS API:
   • After logging in, navigate to the "Products" section.
   • Select the "PBS Public API v3" product.
   • Click "Subscribe" to request access to the API.
4. Get the Subscription Key:
   • After approval, go to your profile.
   • Navigate to the "Subscriptions" or "API Keys" section.
   • Copy your primary or secondary key.
5. Configure the Environment:
   • Create a .env file based on the .env.example template.
   • Replace your-subscription-key-here with your actual subscription key:

     PBS_API_SUBSCRIPTION_KEY=your-actual-subscription-key
     

Limitations

• The public API is rate - limited, allowing only one request every 20 seconds (shared by all users).
• You can only access the current schedule and schedules released in the past 12 months.
• Some endpoints require specific parameters.
• The API structure and endpoints may change.

💻 Usage Examples

Basic Usage

Get API Information

{
  "endpoint": ""
}

Get Prescribers

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

📚 Documentation

Additional Resources

• PBS Website
• PBS Data Website
• PBS API Documentation
• Model Context Protocol Documentation

📄 License

This project is licensed under the MIT License. For details, see the LICENSE file.

❤️