Read tools
Read tools are available to every token. Inputs are flat objects and IDs are UUIDs. Results use camelCase and ISO 8601 timestamps. Farm returns tool data in structuredContent.result, alongside a JSON text copy.
Apps
list_apps
| Argument | Type | Notes |
|---|---|---|
page | integer | Defaults to 1 |
pageSize | 10 | 25 | 50 | 100 | Defaults to 25 |
Returns your apps with website and install URLs.
get_app
| Argument | Type |
|---|---|
appId | UUID |
Returns app details and its campaign count.
Campaigns
list_campaigns
| Argument | Type | Notes |
|---|---|---|
page, pageSize | See pagination | |
appId | UUID | Optional filter |
status | draft | awaiting_funding | active | paused | closing | closed | Optional filter |
Returns campaign summaries with currency, rewards, budget, and funding balances.
get_campaign
| Argument | Type |
|---|---|
campaignId | UUID |
Returns scope, private instructions, dates, and app context.
Reports
list_reports
| Argument | Type | Notes |
|---|---|---|
page, pageSize | See pagination | |
appId, campaignId | UUID | Optional filters |
status | submitted | needs_information | approved | rejected | duplicate | appealed | Optional filter |
q | string | Search text, up to 200 characters |
Returns report summaries with app and campaign names, reward, currency, review deadlines, and comment counts.
get_report
| Argument | Type |
|---|---|
reportId | UUID |
Returns the full report:
- reported steps, expected and actual behavior, environment
- decision version and timestamps (needed to reverse a decision)
- reward amount and currency
- appeal context and investigation assessment and status
- app and campaign context, including instructions
- comment count and evidence attachment IDs
list_report_comments
| Argument | Type |
|---|---|
reportId | UUID |
page, pageSize |
Returns the conversation in chronological order, with each author's name and role.
Evidence
get_evidence_url
| Argument | Type |
|---|---|
attachmentId | UUID |
Returns a private download URL with MIME type, filename, size, and expiry.
Links expire after 60 seconds
Fetch the file right away, or request a fresh URL. Whether your agent can actually view images or video depends on your client.
Pagination
- Defaults: page
1,25rows. Allowed page sizes:10,25,50,100. - List results contain
itemsandpagination: { page, pageSize, total, totalPages }. - Ordering is stable. A page past the end returns an empty
itemsarray.
Every read tool, its arguments, and what it returns.