Skip to content

Commit ece6df3

Browse files
author
flowcore-platform
committed
fix(index): 📝 Update documentation for get_events tool with additional pagination and filtering details
1 parent 5a9e1df commit ece6df3

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,15 +162,15 @@ server.tool(
162162

163163
server.tool(
164164
"get_events",
165-
"Get events for an event type, this can be paginated by using the cursor returned from the previous call. This is good for getting the payload of the events to inspect them.",
165+
"Get events for an event type, this can be paginated by using the cursor returned from the previous call. This is good for getting the payload of the events to inspect them. You can pageinate by using the cursor returned from the previous call. You can also filter by event id, time bucket, from event id, to event id, order, and page size. The order is ascending by default, and the page size is 500 by default. The cursor returned can be called nextCursor, it is a stringified object or a string, you need to pass it as is to paginate.",
166166
{
167167
eventTypeId: z.string().describe("The event type ID to get events for"),
168168
timeBucket: z
169169
.string()
170170
.describe(
171171
"The time bucket to get events from, the timebucket is in the format of YYYYMMDDhhiiss, normally the ii and ss are 0000",
172172
),
173-
cursor: z.string().optional().describe("The paging cursor for pagination"),
173+
cursor: z.string().optional().describe("The paging cursor for pagination, this will be the nextCursor returned from the previous call"),
174174
pageSize: z.number().default(500).describe("The number of events per page (default is 500)"),
175175
fromEventId: z.string().optional().describe("Start from this event ID"),
176176
afterEventId: z

0 commit comments

Comments
 (0)