Skip to content

Commit 7beea8d

Browse files
gerredcdxker
authored andcommitted
docs: update README with dataset ID support and configuration options
1 parent 5b82cf7 commit 7beea8d

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

clients/mcp-server/README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,20 @@ Required environment variables:
2727
- `TRIEVE_API_KEY`: Your Trieve API key from dashboard.trieve.ai
2828
- `TRIEVE_ORGANIZATION_ID`: Your Trieve organization ID from dashboard.trieve.ai
2929

30-
Alternatively, you can provide these credentials via command-line arguments:
30+
Optional environment variables:
31+
- `TRIEVE_DATASET_ID`: Specific dataset ID to use (if not provided via CLI)
32+
33+
Command-line arguments (override environment variables):
3134
```bash
32-
mcp-server-trieve --api-key <your-api-key> --org-id <your-org-id>
35+
trieve-mcp-server --api-key <your-api-key> --org-id <your-org-id> [--dataset-id <dataset-id>]
3336
```
3437

3538
## Usage
3639

3740
### Starting the Server
3841

3942
```bash
40-
mcp-server-trieve
43+
trieve-mcp-server
4144
```
4245

4346
### Available Tools
@@ -48,12 +51,20 @@ Search through a specified Trieve dataset.
4851
Parameters:
4952
- `query` (string): The search query
5053
- `datasetId` (string): ID of the dataset to search in
54+
- `searchType` (string, optional): "semantic" (default), "fulltext", "hybrid", or "bm25"
55+
- `filters` (object, optional): Advanced filtering options
56+
- `highlightOptions` (object, optional): Customize result highlighting
57+
- `page` (number, optional): Page number, default 1
58+
- `pageSize` (number, optional): Results per page, default 10
5159

5260
Example:
5361
```json
5462
{
5563
"query": "example search query",
56-
"datasetId": "your-dataset-id"
64+
"datasetId": "your-dataset-id",
65+
"searchType": "semantic",
66+
"page": 1,
67+
"pageSize": 10
5768
}
5869
```
5970

@@ -74,14 +85,15 @@ The Trieve MCP Server supports MCP integration with [Claude Desktop](https://mod
7485
"args": ["trieve-mcp-server@latest"],
7586
"env": {
7687
"TRIEVE_API_KEY": "$TRIEVE_API_KEY",
77-
"TRIEVE_ORGANIZATION_ID": "$TRIEVE_ORGANIZATION_ID"
88+
"TRIEVE_ORGANIZATION_ID": "$TRIEVE_ORGANIZATION_ID",
89+
"TRIEVE_DATASET_ID": "$TRIEVE_DATASET_ID"
7890
}
7991
}
8092
}
8193
}
8294
```
8395

84-
Note, instead of environment variables, `--api-key` and `--org-id` can be used as arguments.
96+
Note: Instead of environment variables, `--api-key`, `--org-id`, and `--dataset-id` can be used as command-line arguments.
8597

8698
Once Claude Desktop starts, attachments will be available that correspond to the [datasets available to the Trieve organization](https://docs.trieve.ai/guides/create-organizations-and-dataset). These can be used to select a dataset. After that, begin chatting with Claude and ask for information about the dataset. Claude will use search as needed in order to filter and break down queries, and may make multiple queries depending on your task.
8799

0 commit comments

Comments
 (0)