Export Hive JSON-RPC as OpenAPI / OpenRPC for agent tooling
Summary
Export Hive JSON-RPC API definitions from the developer portal as machine-readable OpenAPI 3 and/or OpenRPC so agentic tools (codegen, MCP wrappers, LLM tool-calling) can ingest the surface without scraping HTML.
Related: Work Item #84 (closed) / MR !180 (merged) (agent onboarding + llms.txt) listed this as a follow-up.
Why
developers.hive.iodocuments APIs in Jekyll/_data/apidefinitions, but agents and SDK generators expect OpenAPI/OpenRPC.- An export unblocks MCP servers, client stubs, and richer
llms.txt/ skill packs without duplicating method docs by hand.
Proposed scope
- Source of truth: generate from existing
_data/apidefinitions(and any related YAML) so HTML docs and the schema stay in sync. - Artifacts: publish at stable URLs on the built site, e.g.
/openapi.yamland/or/openrpc.json(exact paths TBD), linked from Resources and the agent section ofllms.txt. - Coverage: broadcast / database / condenser (and other documented namespaces) with method names, params, result shapes, and short descriptions where already present.
- CI: assertion that the export builds and stays valid (schema smoke + link from nav/
llms.txt). - Docs: short “Using the OpenAPI/OpenRPC export” note on the Building agents / API reference path.
Out of scope (for this item)
- Full MCP server implementation
- Changing on-chain RPC behavior
- Non-English localization of the schema descriptions (can follow)
Acceptance
- Generated OpenAPI and/or OpenRPC checked into build output from
apidefinitions - Reachable on staging (
developers-staging.hive.io) and linked from portal +llms.txt - CI validates the artifact(s)
- Brief human docs on how agents/tools should consume it
Notes
Prefer OpenRPC if it maps cleanly to Hive’s JSON-RPC; OpenAPI 3 with a JSON-RPC overlay is fine if the team already has tooling preference. Happy to implement behind an MR to develop once direction is confirmed.