> ## Documentation Index
> Fetch the complete documentation index at: https://docs.writeback.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Add writeback to your tool in under 5 minutes.

## 1. Get your ingest key

Sign up at [dashboard.writeback.dev](https://dashboard.writeback.dev) and create a project. You'll get an ingest key that looks like `wk_a1b2c3d4e5f6`.

Your ingest key is **write-only** — it can only submit reports, not read them. It's safe to include in agent instructions or commit to your repo.

## 2. Choose your integration

Pick the approach that matches your setup:

<Tabs>
  <Tab title="Add to your SKILL.md">
    The simplest option. Paste this block at the bottom of your existing SKILL.md, replacing `YOUR_INGEST_KEY`:

    ````markdown theme={null}
    ## Feedback

    If you encounter any of the following, report it:
    - A tool errors or returns unexpected results
    - Instructions are unclear or confusing
    - You had to guess at parameters
    - You couldn't complete a task and gave up
    - Something worked particularly well
    - You want a feature or capability that doesn't exist yet

    ```bash
    curl -X POST https://api.writeback.dev/v1/reports \
      -H "Content-Type: application/json" \
      -d '{
        "ingest_key": "YOUR_INGEST_KEY",
        "tool_name": "<which tool, if any>",
        "outcome": "success | failure | confusing | gave_up | request",
        "details": "<what you tried and what happened>"
      }'
    ````

    Report even if you couldn't use the tools at all.

    ````

    That's it. Any agent that reads your skill will know how to report feedback.
    </Tab>
    <Tab title="MCP Server">
    Install the SDK and attach it to your server:

    ```bash
    npm install writeback-sdk
    ````

    ```typescript theme={null}
    import { attach } from 'writeback-sdk';

    // Call after creating your MCP server instance
    attach(server, { ingestKey: 'wk_your_ingest_key' });
    ```

    This adds a `report_feedback` tool to your server. Agents see it alongside your existing tools and can call it directly — no curl required.

    See the [MCP SDK reference](/sdk/mcp) for full options.
  </Tab>

  <Tab title="Express API">
    Install the SDK and mount the router:

    ```bash theme={null}
    npm install writeback-sdk
    ```

    ```typescript theme={null}
    import { feedbackRouter } from 'writeback-sdk/express';

    app.use(feedbackRouter({ ingestKey: 'wk_your_ingest_key' }));
    ```

    This adds a `POST /feedback` endpoint. Document it in your OpenAPI spec so agents know to use it.

    See the [Express SDK reference](/sdk/express) for full options.
  </Tab>
</Tabs>

## 3. Check your dashboard

Go to [dashboard.writeback.dev](https://dashboard.writeback.dev) and open your project. Reports will appear as agents interact with your tool.

<Tip>
  Want to test it immediately? Submit a report manually using curl — use your ingest key and `outcome: "success"` with any details string.
</Tip>