# Reporting bugs

We include brief guidelines below for submitting bug reports. These guidelines are designed to make it easier for the maintainers and the community to understand the report and to quash that bug.

## How to write bug reports

Bug reports are tracked as GitHub issues, such as these in [weaviate/weaviate](https://github.com/weaviate/weaviate/issues).

Once you've determined which repository your bug is related to, check first for a duplicate WIP (work in progress) issue.

If not, open an issue in that repository with **a complete, specific and accurate description**. We recommend using this [template](https://github.com/weaviate/docs/blob/main/.github/ISSUE_TEMPLATE/report_bug.yml).

- **Use a clear and descriptive title** for the issue.
- **Describe the exact steps** needed to reproduce the problem with as much detail as possible. For example, include any custom Weaviate configurations, modules used or shell commands.
- **Give specific examples** to show the bug. This could be links or code snippets. For snippets, [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines) are better than images or animated GIFs.
- Explain what **you expected to see instead** and why.
- (If relevant) **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem.
- If the problem was not caused by a specific action, describe what you were doing before the problem occurred and any additional information which may help to reproduce or identify the problem.

## Questions and feedback

Have a question or feedback? Here's how to reach us.

::::card-grid
:::card{title="Community Forum" href="https://forum.weaviate.io/c/support" icon="messages-square"}
Ask questions and connect with other developers on our **Community forum**.
:::

:::card{title="Support" href="/guides/support-overview" icon="life-buoy"}
Weaviate Cloud user or customer? Find the right channel on the **Support page**.
:::
::::

## Related pages

- [Agents](./agents-index.md)
- [AI-assisted Weaviate code generation](./ai-assisted-vibe-coding-index.md)
- [APIs](./apis-index.md)
- [Authorization and authentication](./authorization-and-authentication-index.md)
- [Benchmarks](./benchmarks-index.md)
- [Best practices](./best-practices-index.md)
- [Client libraries](./clients-index.md)
- [Client Libraries / SDKs](./client-libraries-index.md)
- [Cloud](./cloud-index.md)
- [Cloud account management](./cloud-account-management-index.md)

# Agent Instructions

This portal answers questions programmatically. To receive a synthesized,
source-cited answer instead of crawling page by page, append the `?ask=`
query parameter to any page URL on this site:

    /guides/quickstart?ask=how+do+I+authenticate

Optional parameters:

- `&goal=<what-you-are-trying-to-do>` steers the answer toward your
  objective (e.g. `&goal=write+a+python+client`).
- `&version=<label>` scopes the answer to a mounted version when the
  portal publishes more than one.

The response is `text/markdown`: the answer followed by a `# Sources` list
of the portal pages it was grounded in. Status codes are the contract:

- `200` — the answer; `402` — the portal owner’s plan or answer credits are
  exhausted (surface this to your operator; do NOT retry); `429` — you are
  rate-limited; back off for the `Retry-After` seconds; `503` — the answer
  lane is temporarily unavailable; fall back to crawling the `.md` pages.

For the full corpus map read `llms.txt` at the site root; for the tool
surface (search + page fetch as MCP tools) see `/mcp`.