Hamster OSS docs
Everything published about Hamster OSS, in the order most people need it.
Quickstart
Sign up free, save and verify a card for $15 in credit, and create an instance. Get access walks through each step.
Add
https://<your-team>.tryhamster.dev/mcpto your agent. Clients with sign-in need only the address; see Hamster OSS MCP server.Make the first call: the
readtool with path/.To run Hamster OSS on your own machine instead, install the CLI:
curl -fsSL https://dl.tryhamster.dev/install.sh | sh
Guides
- Get access — from sign-up or an invitation to a connected agent.
- Pricing — instance plans, usage rates and how prepaid billing works.
- Hamster OSS API — OAuth authentication, endpoints and example requests.
- Hamster OSS MCP server — the instance endpoint, the Hamster OSS account MCP server at tryhamster.dev, sign-in and client setup.
- Hamster OSS CLI — the install script, platforms, release tracks and first commands.
- API versioning and deprecation — protocol revisions, the catalog schema version and how breaking changes are announced.
For agents and tools
- Hamster OSS account MCP server — search these pages, read prices and set a person up from an agent. The docs and pricing tools need no sign-in.
- llms.txt — what Hamster OSS is, when to use it and how to call it. Docs llms.txt and Developers llms.txt index just these sections.
- OpenAPI 3.1 document — the agent REST API, the instance MCP endpoint, its OAuth discovery documents and the release catalog.
- API catalog, MCP server card and AI catalog.
- Every page is also Markdown: add
.mdto its address, or sendAccept: text/markdown.