使用说明
@workclear/mcp-server
MCP (Model Context Protocol) server for Australian contractor licence verification via the WorkClear API.
Verify contractor licences across QLD, NSW, VIC, SA, ACT, and NT directly from AI agents like Claude, ChatGPT, or any MCP-compatible client.
Project status: hibernating since 22 September 2026. Existing npm version
1.0.2remains available, but this adapter has no active feature or release roadmap. WorkClear's supported integration surface is the REST API and OpenAPI contract. See STATUS.md for the reactivation policy.
Quick Start
1. Get an API key
Sign up at workclear.com.au and create an API key in your dashboard.
2. Configure your MCP client
Add to your Claude Desktop config (claude_desktop_config.json):
{
"mcpServers": {
"workclear": {
"command": "npx",
"args": ["-y", "@workclear/mcp-server"],
"env": {
"WORKCLEAR_API_KEY": "wc_live_your_key_here"
}
}
}
}
Or run directly:
WORKCLEAR_API_KEY=wc_live_your_key_here npx @workclear/mcp-server
Tools
verify_licence
Verify a specific contractor licence by number.
| Parameter | Type | Required | Description |
|---|---|---|---|
licence_number |
string | ✅ | The licence number to verify |
state |
string | ❌ | State code (QLD, NSW, VIC, ACT, NT, WA, SA, TAS) |
Example: "Verify QBCC licence 54898"
search_licences
Search licences by business name, person name, or ABN.
| Parameter | Type | Required | Description |
|---|---|---|---|
query |
string | ✅ | Search term |
state |
string | ❌ | Filter by state |
limit |
number | ❌ | Max results (1-50, default 10) |
Example: "Search for licence holders named Smith in QLD"
check_licence_status
Quick validity check — is a licence currently active?
| Parameter | Type | Required | Description |
|---|---|---|---|
licence_number |
string | ✅ | The licence number |
state |
string | ❌ | State code (recommended) |
Example: "Is licence 12345 still valid in NSW?"
get_coverage
Check which states are available and how many records are in the database.
No parameters required.
Environment Variables
| Variable | Required | Default | Description |
|---|---|---|---|
WORKCLEAR_API_KEY |
✅ | — | Your WorkClear API key |
WORKCLEAR_API_URL |
❌ | https://workclear.com.au |
API base URL (for self-hosted) |
API Limits
Your API call limits depend on your WorkClear plan:
| Plan | API + MCP calls/month | Price |
|---|---|---|
| Free | Web only (no API) | $0 |
| Pro | 1,000 | $29/mo |
| Business | 10,000 | $99/mo |
| Enterprise | Unlimited | Custom |
Each MCP tool call counts as one API call. Upgrade at workclear.com.au/pricing.
Development
# Install dependencies
npm install
# Build
npm run build
# Run in development mode
WORKCLEAR_API_KEY=your_key npm run dev
Reactivation
This repository is retained as the public source attached to npm 1.0.2 and is
archived while the package is hibernating. Do not publish a new version without
a confirmed demand signal, current protocol/API review, security validation and
a reviewed token-free release workflow.
License
MIT — see LICENSE for details.
