# Getting Started

> Onboarding is the most important part of your developer experience. Restless makes it easy for your developers to get their agent set up and ready to build.

Source: https://www.restless.ai/getting-started

## Features

- AI-native onboarding connects them to your MCP server and gets them coding in a single step.
- Import your SDK so onboarding sets developers up on the right library.
- Replace getting started docs with interactive onboarding.

## Get developers to 200 Okay

Restless walks each developer through connecting, adding a key, and making a first call.

### Getting Started page

A getting started page that helps your users understand how to build on your API. It takes them from first login to a working call, one guided step at a time.

### MCP Setup

While users onboard to your API, connect them to your MCP server too, so their agents write better code, debug issues, and stay current as your API changes.

### Languages

Specific instructions for every language you support, with copy-paste setup for each.

- Bun
- Node.js
- Ruby
- PHP
- Python

### SDK installation

Import your SDKs so users install the right one and build on your platform the way you intend.

### Skills

Restless builds skills for your API, so agents onboard themselves and learn how to use it without custom prompts from you.

### Use cases

Setup is the easy part. Restless suggests the most common things people build with your API, so users start on a real task instead of a blank page.

## Related features

- [Documentation](https://www.restless.ai/documentation) — A reference that generates itself from your API and context.
- [MCP Server](https://www.restless.ai/mcp-server) — The hosted server users connect to in the first step.
- [Agent Recovery](https://www.restless.ai/agent-recovery) — Turn failed calls into fixes an agent can act on.

## Turn on Getting Started in 5 minutes

Run the command in your repo and the guided start shows up in your portal, wired to your API.

## Setup

Setup is a breeze. Restless is tightly integrated with your API, so we install a small SDK. Don't worry, we walk you through every step of the way.

Run this in your API's repo:

```sh
npx restless init
```

Or hand the setup to your coding agent with this prompt:

```text
Set up Restless in this repo by running `npx restless init` and following the steps.
```

To try it on a demo API instead:

```sh
git clone git@github.com:restlesshq/demo.git && cd demo && npx restless init
```

Nothing is uploaded without your permission.

The CLI runs four steps:

1. **Map out APIs.** Locate your APIs, generate an OpenAPI (OAS) file, and write it to `.restless/`. An OAS file is the shape of your API: every endpoint, parameter, and response. Later steps use it to install the right adapter and wire up the middleware exactly. The scan points Claude Code, running locally on your machine, at your codebase to find your routes. Commit the `.restless/` folder along with your code; it's meant to live there.
2. **Install SDK.** The CLI detects the project runtime, selects its adapter, installs the Restless SDK and wires the request middleware.
3. **Test your setup.** Local traffic capture starts, and the CLI confirms requests are reaching Restless.
4. **Set up account.** Log in to claim your project on Restless.

Privacy: scanning runs entirely on your machine via your own Claude Code install. We don't see a single line of your code, and nothing gets sent to our servers at that step.

## More from Restless

- [Restless](https://www.restless.ai/index.md): Restless makes your API self-improving. Every API call, support question, and error leaves it better for the next request.
- [Features](https://www.restless.ai/features.md): A new surface for your API: a public, LLM-first hub that gets every caller started and keeps them moving.
- [Documentation](https://www.restless.ai/documentation.md): Restless generates your API documentation from your endpoints and the tools your team already uses, and keeps it current every time your API changes.
- [Agentic docs](https://www.restless.ai/agentic-docs.md): Restless isn't just agent-friendly docs. It's the only documentation platform built AI-first. There's a UI for humans, but the docs are shaped to make agents successful.
- [Workbench](https://www.restless.ai/workbench.md): The Workbench sits at the bottom of your docs and gives developers a view into everything that's happening: view and filter logs, see what went wrong, and fix issues.
- [Agent recovery](https://www.restless.ai/agent-recovery.md): When an agent hits an error on your API, it usually gives up and you never hear about it. Restless catches the failed call and tells the agent how to fix its request and retry.
- [Human support](https://www.restless.ai/human-support.md): When a developer hits something AI can't fix, a human can step in and answer the question. Every answer becomes part of the context, and makes the next question easier!
- [API Logs](https://www.restless.ai/logs.md): Your API is now how your users use your product. Restless brings every request into one place, so you can see which endpoints get hit, which calls fail, and where people give up.
- [MCP server](https://www.restless.ai/mcp-server.md): Give agents the ability to do more than just write code. Give them access to do everything they need to build on your product, such as reading docs, debugging API calls and updating settings.
- [AI Traffic](https://www.restless.ai/ai-traffic.md): Your API and docs get a lot of AI traffic now, and most of it is invisible. Restless shows you what AI is actually looking for, broken down by who is asking.
- [Self-updating docs](https://www.restless.ai/self-updating-docs.md): Restless reads resolved support conversations, pulls out the part that applies to everyone, and drops it in an inbox to review. Approve it and it becomes context the next person finds on their own.
- [Solicit feedback](https://www.restless.ai/solicit-feedback.md): When an agent hits something confusing in your API, it usually just gives up. Restless adds a send_feedback tool to your MCP server, so the agent can tell you what tripped it up.
- [Sign up](https://app.restless.ai/signup)
