<!-- Onboard your AI coding agent — Uptimely -->
> Markdown version of https://getuptimely.com/agent-setup — the page itself is the canonical copy.

AI agents

# Onboard your AI coding agent to Uptimely

Connect your agent from the pill below, or paste this sentence into any coding agent. It fetches `/agent-setup/prompt.md` and configures itself: it registers the Uptimely MCP server over OAuth in your browser, and only asks for an API key if you also want the SDK or the REST API.

Onboard your AI agent to Uptimely+7

```
Fetch and execute the appropriate instructions to set me up for Uptimely from https://getuptimely.com/agent-setup/prompt.md
```

Copy the sentence

Guides

## Or set it up by hand

Pick your agent for the exact command or config entry.

[Claude CodeOne command in a terminal.](https://getuptimely.com/agent-setup/claude-code)[CodexOne command in a terminal.](https://getuptimely.com/agent-setup/codex)[CursorAdd an entry to \~/.cursor/mcp.json (or .cursor/mcp.json in one project).](https://getuptimely.com/agent-setup/cursor)[OpenCodeAdd an entry to opencode.json (project) or \~/.config/opencode/opencode.json.](https://getuptimely.com/agent-setup/opencode)[WindsurfAdd an entry to \~/.codeium/windsurf/mcp\_config.json.](https://getuptimely.com/agent-setup/windsurf)[VS Code and GitHub CopilotAdd an entry to .vscode/mcp.json.](https://getuptimely.com/agent-setup/vscode)[Gemini CLIOne command in a terminal.](https://getuptimely.com/agent-setup/gemini-cli)[Claude (claude.ai)Configured in the client's own settings.](https://getuptimely.com/agent-setup/claude)[ChatGPTConfigured in the client's own settings.](https://getuptimely.com/agent-setup/chatgpt)

What you get

## One setup, three ways in

- Remote MCP server`https://app.getuptimely.com/api/mcp`
- TypeScript SDK`@uptimely/sdk`
- REST API`https://app.getuptimely.com/v1`

The MCP server authenticates with OAuth 2.1 in your browser — no key needed. The SDK and REST API need a project API key from Settings → API keys. Full tool list and write-access rules are in the [MCP and AI docs](https://getuptimely.com/docs/mcp-and-ai).

Verify

## Confirm it worked

Ask your agent to call `search_tools`, then `execute_typescript` with `return await external_uptimely_project_list({});`. A client that lists `uptimely_project_list` as its own tool can call it directly. A JSON list of your projects — even an empty list — means the connection is live. Each guide below also carries a REST check for the SDK/API path.

Canonical copy of the machine-readable instructions: [https://getuptimely.com/agent-setup/prompt.md](https://getuptimely.com/agent-setup/prompt.md)
