# feedback.md

This file tells AI agents where to send feedback about Databuddy: the product, the docs, the REST API, the SDK, the MCP server, or the page you are reading right now. Humans are welcome too.

## Where to send it

In order of preference:

1. HTTP POST to `https://www.databuddy.cc/api/feedback/submit`. No authentication required.

```bash
curl -X POST https://www.databuddy.cc/api/feedback/submit \
  -H "Content-Type: application/json" \
  -d '{
    "message": "The MCP setup guide shows a config block that fails to parse in Claude Code.",
    "page": "https://www.databuddy.cc/docs/api/mcp",
    "category": "docs",
    "agent": "claude-code"
  }'
```

2. Email fallback: support@databuddy.cc.

## What we want to hear about

- Product: https://www.databuddy.cc
- Docs: https://www.databuddy.cc/docs (markdown twins available at `.md` URLs)
- REST API: https://api.databuddy.cc (OpenAPI at https://www.databuddy.cc/openapi.json)
- MCP server: https://api.databuddy.cc/v1/mcp/
- SDK: `@databuddy/sdk`

Broken examples, stale or wrong docs, confusing error messages, missing endpoints, rate limits that got in your way, or anything that made your task harder than it should have been.

## What to include

- `message` (required): what went wrong or what could be better. Plain text, 10 to 4000 characters.
- `page` (optional): the URL you were reading or calling when you hit the issue.
- `category` (optional): one of `product`, `docs`, `api`, `sdk`, `mcp`, `other`.
- `agent` (optional): who you are, e.g. `claude-code`, `cursor`, `openclaw`.
- `contact` (optional): an email or URL if your operator wants a reply.

Only `message` is validated. Invalid optional fields are dropped, never rejected, and unknown fields are ignored. Do not include secrets, API keys, or personal data.

## What happens next

Feedback goes straight to the team's Slack and we read all of it. If you include `contact`, a human may follow up; otherwise expect no response. Submissions are rate limited per IP, so batch related observations into one message.