omkarbhede/agent-hoppscotch

Overview

This skill is a CLI tool for managing Hoppscotch API documentation, collections, requests, and environments programmatically. It helps AI agents and developers create, update, import, and run API requests inside Hoppscotch from the terminal. Use it to keep documentation and collections in sync with your code and CI workflows.

How this skill works

The CLI checks and sets configuration (GraphQL endpoint and session cookie), then uses Hoppscotch GraphQL APIs to list, create, update, move, export, and run collections and requests. It supports REST, GraphQL, and realtime request types (WebSocket, SSE, Socket.IO, MQTT) and can manage teams, environments, and defaults. Global flags enable JSON output, verbose GraphQL debugging, or runtime overrides for endpoint and cookie.

When to use it

• When you need to add or update API documentation and requests in Hoppscotch from scripts or agents.
• When onboarding or switching teams and you must configure endpoints, cookies, and default collections programmatically.
• When automating exports, backups, or CI-driven updates of collections and requests.
• When creating or maintaining GraphQL queries, realtime endpoints, and environment variables centrally.
• When running or validating requests from a terminal or within automation pipelines.

Best practices

• Run auth status first; if not configured, set the GraphQL endpoint and browser session cookie before other commands.
• Use --json for machine-readable output in automation and --verbose to debug GraphQL payloads during integration.
• Store team and collection defaults with auth set-default to avoid passing IDs on every command.
• Validate request bodies with --validate-body and use description files for large request or test scripts.
• Use export commands to create backups before bulk deletes or mass updates.

Example use cases

• Automate adding a new API endpoint: create a collection and add requests with method, headers, body, and tests.
• Import GraphQL operations from a codebase: create graphql requests with queries and variables for QA teams.
• CI job that updates environment variables and deploys an updated collection JSON to Hoppscotch.
• Move or refactor requests between collections and teams during a project reorganization.
• Run a saved request from the terminal with variable overrides for quick smoke tests.