55 lines
1.7 KiB
Markdown
55 lines
1.7 KiB
Markdown
|
---
|
||
|
|
name: gainsight-px
|
||
|
|
description: Interact directly with the Gainsight PX REST API to fetch user/account data or track events.
|
||
|
|
tools:
|
||
|
|
- name: px_get_user
|
||
|
|
description: Fetch a specific user by their unique identity ID.
|
||
|
|
entry:
|
||
|
|
type: python
|
||
|
|
path: gainsight_px.py
|
||
|
|
args: ["get_user"]
|
||
|
|
- name: px_get_account
|
||
|
|
description: Fetch a specific account by its ID.
|
||
|
|
entry:
|
||
|
|
type: python
|
||
|
|
path: gainsight_px.py
|
||
|
|
args: ["get_account"]
|
||
|
|
- name: px_search_user
|
||
|
|
description: Search for a user in Gainsight PX by their email address.
|
||
|
|
entry:
|
||
|
|
type: python
|
||
|
|
path: gainsight_px.py
|
||
|
|
args: ["search_user"]
|
||
|
|
- name: px_track_event
|
||
|
|
description: Track a custom event for a user in Gainsight PX. Requires user_id, event_name, and optional JSON properties.
|
||
|
|
entry:
|
||
|
|
type: python
|
||
|
|
path: gainsight_px.py
|
||
|
|
args: ["track_event"]
|
||
|
|
---
|
||
|
|
|
||
|
|
# Gainsight PX REST API Skill
|
||
|
|
|
||
|
|
This skill allows agents to natively interface with your Gainsight PX instance without needing an intermediate MCP server like Pipedream or Zapier.
|
||
|
|
|
||
|
|
## Setup
|
||
|
|
|
||
|
|
You must export your API key before using the tools. You can generate an API key from your Gainsight PX Administration -> REST API section.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# Add this to your environment
|
||
|
|
export GAINSIGHT_PX_API_KEY="your-api-key-here"
|
||
|
|
|
||
|
|
# Optional: If you are in the EU region, set this flag. Default is US.
|
||
|
|
export GAINSIGHT_PX_REGION="EU"
|
||
|
|
```
|
||
|
|
|
||
|
|
## How It Works
|
||
|
|
|
||
|
|
It uses a lightweight Python script (`gainsight_px.py`) that implements standard REST endpoints documented by Apiary (`https://api.aptrinsic.com/v1/...`).
|
||
|
|
|
||
|
|
### Capabilities
|
||
|
|
- **Lookups:** Find exactly who a user is by ID or email.
|
||
|
|
- **Account Context:** Pull account metadata.
|
||
|
|
- **Event Injection:** Push arbitrary telemetry events natively.
|