gui_deck_overview
View detailed overview of a specific Anki deck by providing the deck name. Simplifies deck management and progress tracking within the Anki MCP server.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| deckName | Yes | Name of the deck to view overview for |
Implementation Reference
- src/tools/graphical.ts:171-194 (registration)Full registration of the 'gui_deck_overview' MCP tool, including input schema (deckName string), handler logic that invokes Anki's guiDeckOverview via ankiClient, and returns textual success response.// Tool: Open deck overview server.tool( 'gui_deck_overview', { deckName: z.string().describe('Name of the deck to view overview for'), }, async ({ deckName }) => { try { const result = await ankiClient.graphical.guiDeckOverview({ name: deckName }); return { content: [ { type: 'text', text: `Successfully opened deck overview for "${deckName}". Result: ${result}`, }, ], }; } catch (error) { throw new Error( `Failed to open deck overview: ${error instanceof Error ? error.message : String(error)}` ); } } );
- src/tools/graphical.ts:177-194 (handler)The core handler function executing the tool: calls ankiClient.graphical.guiDeckOverview with deck name and handles response/error.async ({ deckName }) => { try { const result = await ankiClient.graphical.guiDeckOverview({ name: deckName }); return { content: [ { type: 'text', text: `Successfully opened deck overview for "${deckName}". Result: ${result}`, }, ], }; } catch (error) { throw new Error( `Failed to open deck overview: ${error instanceof Error ? error.message : String(error)}` ); } } );
- src/tools/graphical.ts:174-176 (schema)Zod input schema requiring a 'deckName' string parameter.{ deckName: z.string().describe('Name of the deck to view overview for'), },