Shruwd is built to be driven by a person or by an agent. The public API covers the whole product, and two clients sit on top of it.
The API
Mint a key under Account → API keys and send it as a bearer token. A key uses the product with your role and never administers the account: it cannot mint other keys, change billing or delete anything that is not brand configuration. Keys come in two scopes, read and read plus write.
The contract describes itself at /api/v1/openapi.json, which needs no key to read. Errors share one shape, and a metric comes with its interval or as an explicit insufficient_data state, never as a bare number. Start with the API overview.
The TypeScript SDK
@shruwd/sdk is a typed client whose types are generated from the OpenAPI document, so it cannot drift from the API. ESM, retries and structured errors built in, no runtime dependencies beyond fetch.
npm install @shruwd/sdk
See the SDK guide.
The MCP server
shruwd-mcp gives Claude Desktop, Claude Code or Cursor tools to set up a brand, add prompts and competitors, read how the brand appears in answers and act on findings. It runs on your machine over stdio with your key; there is no hosted server. Setup is one config entry, shown in MCP server.
For agents reading the docs
Every docs page is also markdown: append .md to its URL. /llms.txt indexes them, /llms-full.txt holds the whole set in one file, and /skill.md is a procedure for setting a brand up end to end. See for AI agents.