Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions docs/sdk/api-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ themselves), see the

### Search Parameters

The `search_global` and `search_tenant` tools accept the
Comment thread
mataai marked this conversation as resolved.
same parameters:
The `search_global` and `search_tenant` tools accept the following
parameters:

<ParamField body="query" type="string" required>
Lucene query.
Expand All @@ -50,6 +50,12 @@ same parameters:
List of event types to scope the search. Defaults to all event types.
</ParamField>

<ParamField body="severity" type="array of string">
Filter results by event severity. Passing an array returns only events whose
severity exactly matches one of the listed values. Allowed values: `info`,
`low`, `medium`, `high`, `critical`.
</ParamField>

<ParamField body="size" type="integer" default="10">
Number of results to return. Between `1` and `10`.
</ParamField>
Expand All @@ -58,6 +64,25 @@ same parameters:
Opaque pagination cursor from a previous response.
</ParamField>

#### Tenant Search Parameters

In addition to the shared parameters above, `search_tenant` accepts the
following tenant-scoped filters:

<ParamField body="tags" type="array of string">
Filter results to events that carry at least one of the given tenant tags.
</ParamField>

<ParamField body="is_ignored" type="boolean">
If `true`, only return events that have been marked as ignored. `false` has no
effect and behaves the same as omitting it.
</ParamField>

<ParamField body="is_remediated" type="boolean">
If `true`, only return events that have been marked as remediated. `false` has
no effect and behaves the same as omitting it.
</ParamField>

### Prompt Examples

- `What has Flare picked up on our monitored domain scatterholt.com in the last 24 hours?`
Expand Down
Loading