# ReelsFarm Agent Guide

Use ReelsFarm from AI agents, MCP clients, shell workflows, and TypeScript code. Start here, then fetch the exact guide your agent needs.

Canonical: /docs.md

## Choose the interface

| Use this | When | Entry point |
| --- | --- | --- |
| MCP | Your AI client supports remote MCP servers and tool discovery. | https://mcp.reelsfarm.com/mcp |
| SDK | You are building a custom TypeScript agent or product integration. | @reelsfarm/mcp-client |
| CLI | Your agent can run terminal commands, CI jobs, or scripts. | reelsfarm |

> Default endpoint: The canonical MCP endpoint is https://mcp.reelsfarm.com/mcp. The marketing page at /mcp is not the protocol endpoint.

## The safety model

ReelsFarm is built around prepare, review, confirm, and track. Actions that spend credits, schedule posts, publish content, update scheduled posts, delete scheduled posts, or create automations return a short-lived confirmation first.

- Read-only calls inspect account state, assets, posts, events, pricing, and connected accounts.
- Prepare calls return a confirmationId, summary, expiry, and credit estimate when relevant.
- confirm_action executes the prepared action after review.
- Status calls track jobs, scheduled posts, exports, events, and webhook activity.

## Fastest useful check

**Terminal**
```bash
npm install -g @reelsfarm/mcp-client
reelsfarm login --api-key rfmcp_xxx
reelsfarm agent status
reelsfarm social connected --agent
```

**TypeScript**
```ts
import { ReelsFarmClient } from "@reelsfarm/mcp-client";

const rf = new ReelsFarmClient({
  apiKey: process.env.REELSFARM_API_KEY,
});

const account = await rf.account.get();
const connected = await rf.social.listConnected();

console.log({ account, connected });
await rf.close();
```

## AI-readable docs

Every guide has a Markdown mirror. Agents should fetch the Markdown version when they need setup instructions, command examples, or a compact reference.

- Start here: /docs.md
- MCP: /docs/mcp.md
- SDK & CLI: /docs/agents.md
- Workflows: /docs/workflows.md
- Reference: /docs/reference.md
- Webhooks: /docs/webhooks.md
- Troubleshooting: /docs/troubleshooting.md
- llms.txt: /llms.txt