---
title: "Hamster OSS docs"
description: "Hamster OSS documentation: get access, pricing, the Hamster OSS API, the MCP server, the system CLI and the files agents read."
canonical: "https://tryhamster.dev/docs"
last-updated: "2026-11-05"
---

# Hamster OSS docs

> Hamster OSS documentation: get access, pricing, the Hamster OSS API, the MCP server, the system CLI and the files agents read.

Everything published about Hamster OSS, in the order most people need it.

## Quickstart

1. Sign up free, save and verify a card for $15 in credit, and create an instance. [Get access](https://tryhamster.dev/get-access) walks through each step.
2. Add `https://<your-team>.tryhamster.dev/mcp` to your agent. Clients with sign-in need only the address; see [Hamster OSS MCP server](https://tryhamster.dev/docs/mcp).
3. Make the first call: the `read` tool with path `/`.
4. To run Hamster OSS on your own machine instead, install the CLI:

   ```sh
   curl -fsSL https://dl.tryhamster.dev/install.sh | sh
   ```

## Guides

- [Get access](https://tryhamster.dev/get-access) — from sign-up or an invitation to a connected agent.
- [Pricing](https://tryhamster.dev/pricing) — instance plans, usage rates and how prepaid billing works.
- [Hamster OSS API](https://tryhamster.dev/developers) — OAuth authentication, endpoints and example requests.
- [Hamster OSS MCP server](https://tryhamster.dev/docs/mcp) — the instance endpoint, the Hamster OSS account MCP server at tryhamster.dev, sign-in and client setup.
- [Hamster OSS CLI](https://tryhamster.dev/cli) — the install script, platforms, release tracks and first commands.
- [API versioning and deprecation](https://tryhamster.dev/docs/api-versioning) — protocol revisions, the catalog schema version and how breaking changes are announced.

## For agents and tools

- [Hamster OSS account MCP server](https://tryhamster.dev/mcp) — search these pages, read prices and set a person up from an agent. The docs and pricing tools need no sign-in.
- [llms.txt](https://tryhamster.dev/llms.txt) — what Hamster OSS is, when to use it and how to call it. [Docs llms.txt](https://tryhamster.dev/docs/llms.txt) and [Developers llms.txt](https://tryhamster.dev/developers/llms.txt) index just these sections.
- [OpenAPI 3.1 document](https://tryhamster.dev/openapi.json) — the agent REST API, the instance MCP endpoint, its OAuth discovery documents and the release catalog.
- [API catalog](https://tryhamster.dev/.well-known/api-catalog), [MCP server card](https://tryhamster.dev/.well-known/mcp/server-card.json) and [AI catalog](https://tryhamster.dev/.well-known/ai-catalog.json).
- Every page is also Markdown: add `.md` to its address, or send `Accept: text/markdown`.

## Company

[About](https://tryhamster.dev/about), [Contact](https://tryhamster.dev/contact) and [Privacy](https://tryhamster.dev/privacy).