# Traversaal (https://www.librechat.ai/docs/configuration/tools/traversaal)

Traversaal is a built-in agent search tool that sends a natural-language query to Traversaal Ares and returns a response with source URLs when available.

## Setup

<Steps>
  <Step>

### Get a Traversaal API Key

Create an account and get an API key from [api.traversaal.ai](https://api.traversaal.ai/).

  </Step>
  <Step>

### Add the Environment Variable

Add the key to your `.env` file:

```bash filename=".env"
TRAVERSAAL_API_KEY=your-api-key
```

  </Step>
  <Step>

### Restart LibreChat

| Deployment | Command |
|------------|---------|
| Docker | `docker compose down && docker compose up -d` |
| Local | Stop the server, then run `npm run backend` again |

  </Step>
  <Step>

### Add Traversaal to an Agent

In LibreChat, select **Agents**, create or edit an agent, open the agent's **Tools** list, select **Traversaal**, and save the agent.

  </Step>
</Steps>

## Parameters

| Parameter | Description |
|-----------|-------------|
| `query` | A complete sentence describing what the agent should search for. Required. |

## Example Prompts

```text
Find recent reporting about open source AI coding agents.
Search for sources comparing renewable energy adoption in Europe and North America.
```

## Troubleshooting

- If Traversaal returns an authentication error, confirm `TRAVERSAAL_API_KEY` is set and restart LibreChat.
- If the tool is not visible in the Agent Builder, check [`includedTools`](/docs/configuration/librechat_yaml/object_structure/config#includedtools), [`filteredTools`](/docs/configuration/librechat_yaml/object_structure/config#filteredtools), and the agent's `tools` capability.