API Reference
Developers
Developers
MCP Server
MCP is an open protocol that empowers applications to integrate context into large language models (LLMs) and build powerful, data-driven workflows. By connecting LLMs to external tools and data sources, MCP enables more accurate outputs, deeper insights and more dynamic interactions.
This MCP server connects directly to the Planhat API, offering three core tools to explore, inspect, and operate on Planhat data models in real time.
MCP is an open protocol that empowers applications to integrate context into large language models (LLMs) and build powerful, data-driven workflows. By connecting LLMs to external tools and data sources, MCP enables more accurate outputs, deeper insights and more dynamic interactions.
This MCP server connects directly to the Planhat API, offering three core tools to explore, inspect, and operate on Planhat data models in real time.
MCP is an open protocol that empowers applications to integrate context into large language models (LLMs) and build powerful, data-driven workflows. By connecting LLMs to external tools and data sources, MCP enables more accurate outputs, deeper insights and more dynamic interactions.
This MCP server connects directly to the Planhat API, offering three core tools to explore, inspect, and operate on Planhat data models in real time.
Tools
Purpose:
Discover available Planhat data models and their supported operations
Output:
JSON array of model routes with supported operations
Use case:
Initial API exploration, dynamic tool configuration
Purpose:
Retrieve detailed parameter schemas for specific model-operation combinations
Input:
: Target data model (e.g., "companies", "endusers")
: Desired operation ("create", "update", "view", "list")
Output:
JSON schema with parameter definitions, types, and requirements
Use case:
Schema validation, form generation, parameter discovery
Purpose:
Execute CRUD operations on Planhat data models
Input:
: Target data model
: Operation type
: JSON string containing operation data
Output:
API response (created entity, query results, update confirmation)
Use case:
All data manipulation operations
Tools
Purpose:
Discover available Planhat data models and their supported operations
Output:
JSON array of model routes with supported operations
Use case:
Initial API exploration, dynamic tool configuration
Purpose:
Retrieve detailed parameter schemas for specific model-operation combinations
Input:
: Target data model (e.g., "companies", "endusers")
: Desired operation ("create", "update", "view", "list")
Output:
JSON schema with parameter definitions, types, and requirements
Use case:
Schema validation, form generation, parameter discovery
Purpose:
Execute CRUD operations on Planhat data models
Input:
: Target data model
: Operation type
: JSON string containing operation data
Output:
API response (created entity, query results, update confirmation)
Use case:
All data manipulation operations
Tools
Purpose:
Discover available Planhat data models and their supported operations
Output:
JSON array of model routes with supported operations
Use case:
Initial API exploration, dynamic tool configuration
Purpose:
Retrieve detailed parameter schemas for specific model-operation combinations
Input:
: Target data model (e.g., "companies", "endusers")
: Desired operation ("create", "update", "view", "list")
Output:
JSON schema with parameter definitions, types, and requirements
Use case:
Schema validation, form generation, parameter discovery
Purpose:
Execute CRUD operations on Planhat data models
Input:
: Target data model
: Operation type
: JSON string containing operation data
Output:
API response (created entity, query results, update confirmation)
Use case:
All data manipulation operations
Setup
Access token
1. Go to App Center and create a new private app.
2. Assign the necessary permissions to the app based on your access needs.
3. Generate an access token and use it to authenticate MCP requests.
Usage
Setup
Access token
1. Go to App Center and create a new private app.
2. Assign the necessary permissions to the app based on your access needs.
3. Generate an access token and use it to authenticate MCP requests.
Usage
Setup
Access token
1. Go to App Center and create a new private app.
2. Assign the necessary permissions to the app based on your access needs.
3. Generate an access token and use it to authenticate MCP requests.
Usage
Common error handling
401 Unauthorized
Cause: Missing or invalid access token Fix: Check
Authorization: Bearer <token></token>, ensure token is active and valid
403 Forbidden
Cause: Token lacks permissions
Fix: Update app permissions in App Center
404 Not Found
Cause: Invalid
or
Fix: Use
to confirm supported models/operations
400 Bad Request
Cause: Missing or invalid parameters Fix: Use
, ensure correct types and required fields
429 Too Many Requests
Cause: Rate limit hit Fix: Retry with delay, use
header if present
500 Internal Server Error
Cause: Unexpected server-side issue
Fix: Retry, report with request details if persistent
Common error handling
401 Unauthorized
Cause: Missing or invalid access token Fix: Check
Authorization: Bearer <token></token>, ensure token is active and valid
403 Forbidden
Cause: Token lacks permissions
Fix: Update app permissions in App Center
404 Not Found
Cause: Invalid
or
Fix: Use
to confirm supported models/operations
400 Bad Request
Cause: Missing or invalid parameters Fix: Use
, ensure correct types and required fields
429 Too Many Requests
Cause: Rate limit hit Fix: Retry with delay, use
header if present
500 Internal Server Error
Cause: Unexpected server-side issue
Fix: Retry, report with request details if persistent
Common error handling
401 Unauthorized
Cause: Missing or invalid access token Fix: Check
Authorization: Bearer <token></token>, ensure token is active and valid
403 Forbidden
Cause: Token lacks permissions
Fix: Update app permissions in App Center
404 Not Found
Cause: Invalid
or
Fix: Use
to confirm supported models/operations
400 Bad Request
Cause: Missing or invalid parameters Fix: Use
, ensure correct types and required fields
429 Too Many Requests
Cause: Rate limit hit Fix: Retry with delay, use
header if present
500 Internal Server Error
Cause: Unexpected server-side issue
Fix: Retry, report with request details if persistent