Server Configuration
Describes the environment variables required to run the server.
Name | Required | Description | Default |
---|---|---|---|
API_URL | No | The base URL for the PI API | http://localhost:8224/pi/api/v2 |
PI_API_KEY | Yes | Authentication token for the PI API |
Schema
Prompts
Interactive templates invoked by user choice
Name | Description |
---|---|
analyze-categories | Analyze categories in the dashboard |
analyze-charts | Analyze charts in the dashboard |
compare-charts | Compare data between two charts |
category-usage-analysis | Analyze how categories are being used in charts |
use-filters | Shows how to use filters effectively with this API |
Resources
Contextual data attached and managed by the client
Name | Description |
---|---|
auth-status | |
categories-list | |
charts-list |
Tools
Functions exposed to the LLM to take actions
Name | Description |
---|---|
get-filterable-attributes | Get the list of attributes that can be used for filtering by examining a sample entity |
check-connection | Check if the current API URL and authentication are valid |
set-api-url | Set the API base URL for all requests |
authenticate | Guide for authenticating with the PI API |
keep-session-alive | Verify and refresh the current authentication token (also used for token-based authentication) |
authenticate-with-credentials | Authenticate with the PI API using username and password (last resort option) |
logout | Invalidate the current token and end the session |
set-organization | Set the organization ID for subsequent requests |
list-categories | List all categories with filtering support |
get-category | Get a category by ID |
create-category | Create a new category |
update-category | Update an existing category |
delete-category | Delete a category |
list-category-objects | List all objects for a specific category |
list-charts | List all charts with filtering support |
get-chart | Get a chart by ID |
delete-chart | Delete a chart |
export-chart | Export a chart in various formats |