> For the complete documentation index, see [llms.txt](https://village-labs.gitbook.io/coworker-product-and-developer-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://village-labs.gitbook.io/coworker-product-and-developer-docs/welcome-to-coworker/village-assistant/github-pr-review-tool.md).

# Github PR Review Tool

### How use the PR Review Analysis Report Tool 

When you create a Pull Request, the **@villagelabsco** bot will generate an analysis of the diffs and comment back into the PR with the report. The report includes:

* Code Change Summary
* Potential Vulnerabilities
* Code Smells
* Debug Logs
* Any Unintended Consequences
* Risk Score

{% hint style="info" %}
Depending on the size of the PR, the report can take up to 1 minute to generate. Once the report is generated, it will be posted back into the PR as a comment
{% endhint %}

Check out the demo below to see how the report posts back to your PR:

{% embed url="<https://www.loom.com/share/a5e655749d9846ecaff313c80d0bf2c9>" %}

### How use the Ask Village feature&#x20;

You can also Ask Village any question directly in your PR for instant feedback and further analysis. To use this feature:

* Simply type '@villagelabsco question \<insert\_your\_question>' into your PR as a comment and the @villagelabsco bot will post back the answer as a comment.

{% hint style="info" %}
You must follow the syntax @villagelabsco question \<insert\_your\_question> exactly including the word 'question' to trigger the prompt.

*e.g. @villagelabsco question How can I better handle using two Authentication methods?*
{% endhint %}

Check out the demo below to see how the question prompt posts the response back to your PR:

{% embed url="<https://www.loom.com/share/0a584a65d3f84de1b922d8a4534205d3>" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://village-labs.gitbook.io/coworker-product-and-developer-docs/welcome-to-coworker/village-assistant/github-pr-review-tool.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.