tripgo-api
npx skills add https://github.com/guanyu-zhang/tripgo-api --skill tripgo-api
Agent 安装分布
Skill 文档
SkedGo TripGo API Skill
This skill provides a complete interface to the SkedGo TripGo API, enabling agents to perform multimodal routing, retrieve public transport information, manage trips, and perform geocoding.
Overview
The TripGo API is a platform for multimodal transport, allowing users to plan trips combining public transport, car, bike, taxi, rideshare, and more. This skill encapsulates the API endpoints into modular scripts and documentation references.
Configuration
To use this skill, you must set the following environment variables:
TRIPGO_API_KEY: Your TripGo API key (header:X-TripGo-Key).TRIPGO_BASE_URL: (Optional) Base URL for the API. Defaults tohttps://api.tripgo.com/v1.TRIPGO_WEBHOOK_ALLOWLIST: (Optional, recommended) Comma-separated allowlist of webhook domains (e.g.example.com,webhooks.example.org).TRIPGO_ALLOW_UNSAFE_WEBHOOK: (Optional, defaultfalse) Set totrueto bypass webhook allowlist checks for trusted/manual debugging only.
Runtime Requirements
Install these binaries before running scripts:
curl(required): API requestsjq(required): JSON validation, safe JSON construction, and URL encodingpython3(optional): pretty-printing for a few scripts
Security Notes
- Scripts that accept JSON parameters validate those values with
jqbefore sending requests. - Scripts that send query parameters URL-encode user-provided values.
- Webhook hook registration enforces
https://and domain allowlisting by default (TRIPGO_WEBHOOK_ALLOWLIST) to reduce exfiltration risk. - API key usage is expected: requests send
X-TripGo-Keyto the configured TripGo base URL.
Directory Structure
SKILL.md: This file.references/: Detailed documentation for each API section.scripts/: Executable Bash scripts for each API endpoint.
References (references/)
Documentation is organized by API section. Load these files to understand specific endpoints, parameters, and response structures.
references/configuration.md: Regions, TSPs, and POIs.references/routing.md: Journey planning and routing (A-to-B, multi-point).references/trips.md: Trip management (save, update, real-time hooks).references/ttp.md: Travelling Tourist Problem (Deprecated).references/geocode.md: Search and autocompletion.references/locations.md: Location services and POIs.references/public-transport.md: Public transport operators, routes, services, and real-time data.
Scripts (scripts/)
Each script corresponds to a specific API endpoint. They are designed to be executed directly or used as templates.
Naming Convention: scripts/<section>-<function-name>.sh
Configuration
scripts/configuration-available-regions.shscripts/configuration-tsps-per-region.shscripts/configuration-pois-for-a-transport-mode.sh
Routing
scripts/routing-a-to-b-trips.shscripts/routing-a-to-b-to-c-trip.shscripts/routing-all-day-routing-between-events.shscripts/routing-all-day-routing-between-events-deprecated.sh(Deprecated)
Trips
scripts/trips-retrieve-previously-computed-trip.shscripts/trips-save-trip-for-later-use.shscripts/trips-update-trip-with-real-time-data.shscripts/trips-gets-hooked-urls.shscripts/trips-hooks-a-trip-to-real-time-updates.shscripts/trips-removes-a-hooks-from-a-trip.shscripts/trips-mark-trip-as-planned-by-a-user.sh
TTP (Deprecated)
scripts/ttp-create-travelling-tourist-problem-deprecated.shscripts/ttp-delete-travelling-tourist-problem-deprecated.shscripts/ttp-delete-travelling-tourist-problem-solution-deprecated.sh
Geocode
scripts/geocode-search-and-autocompletion.sh
Locations
scripts/locations-pois-for-a-circular-region.shscripts/locations-pois-for-map-region-using-cell-ids.shscripts/locations-additional-details-for-a-coordinate.sh
Public Transport
scripts/public-transport-operators-for-a-region-or-group-of-regions.shscripts/public-transport-routes-for-a-region-or-operator.shscripts/public-transport-details-of-a-route.shscripts/public-transport-services-for-a-route.shscripts/public-transport-departure-timetable-for-a-stop.shscripts/public-transport-real-time-information-for-a-service.shscripts/public-transport-get-details-of-a-service.shscripts/public-transport-get-real-time-alerts.sh
Usage Constraints
- Do NOT invent parameters. All scripts use parameters explicitly documented in
references/. - Deprecated Endpoints: Some scripts are marked as deprecated (e.g., TTP section). Use with caution or avoid if possible.
- Verification: If a parameter or field is marked as “To be confirmed” in the references, verify with a live API call before relying on it in production.
- Environment: Ensure
TRIPGO_API_KEYis set in the environment before running any script.
Example
Searching for a location:
export TRIPGO_API_KEY="your_key_here"
./scripts/geocode-search-and-autocompletion.sh --query "Sydney Opera House" --near "(-33.8688,151.2093)"
Planning a trip:
./scripts/routing-a-to-b-trips.sh --from "(lat,lng)" --to "(lat,lng)" --region "AU_NSW_Sydney"