Search freebies with scope controls
search_freebiesUse this when the user needs explicit corpus scope, result limits, or a rich normalized list rather than the standard citable search/fetch flow. It is read-only: the default uses site-controlled actionable U.S. trials and savings, while only an explicit open-source scope reads public GitHub. Use public-benefits only for eligibility-based services. Do not use it for purchases, account access, or guaranteed eligibility.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum normalized items to return; answer guides are reported separately. | |
| query | Yes | The user's need in natural language, including provider, product, eligibility, or desired value. | |
| scope | No | auto routes ordinary requests to actionable trials/savings and explicit public-service needs to the broader benefits corpus. | auto |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | Normalized record and repository results returned in items. | |
| items | Yes | Ranked normalized records or, only under an explicit open-source scope, public repository results. | |
| query | Yes | Normalized user query used for retrieval. | |
| usage | Yes | Next-step, ranking, and caution guidance for the returned result set. | |
| sources | Yes | Per-corpus matched, omitted, and returned counts. | |
| api_version | Yes | Andrew’s Freebies search contract version. | |
| result_count | Yes | Complete count across answer_guides and items. | |
| answer_guides | Yes | ||
| resolved_scope | Yes | ||
| requested_scope | Yes | ||
| answer_guide_count | Yes |