get_checklist
Retrieve a complete bird observation checklist from the eBird database by providing its unique identifier to access all recorded sightings and details.
Instructions
Get details of a specific checklist including all observations.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sub_id | Yes | The checklist identifier (e.g., 'S29893687') |
Implementation Reference
- src/index.ts:373-376 (handler)The asynchronous handler function for the 'get_checklist' tool. It takes the sub_id argument, makes an API request to the eBird product endpoint for checklist details, and returns the result as JSON-formatted text content.
async (args) => { const result = await makeRequest(`/product/checklist/view/${args.sub_id}`); return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] }; } - src/index.ts:370-372 (schema)Zod schema defining the input parameters for the 'get_checklist' tool, specifically the required 'sub_id' string parameter.
{ sub_id: z.string().describe("The checklist identifier (e.g., 'S29893687')"), }, - src/index.ts:367-377 (registration)The server.tool() call that registers the 'get_checklist' tool, specifying its name, description, input schema, and handler function.
server.tool( "get_checklist", "Get details of a specific checklist including all observations.", { sub_id: z.string().describe("The checklist identifier (e.g., 'S29893687')"), }, async (args) => { const result = await makeRequest(`/product/checklist/view/${args.sub_id}`); return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] }; } );