list_category_items
Retrieve documentation items from Microsoft Flight Simulator SDK categories to access structured development resources.
Instructions
Returns all items for a given documentation category
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| category | Yes | Category to list items from (index, contents, or glossary) |
Implementation Reference
- The core handler function that implements the 'list_category_items' tool. It validates the category, uses embedded data for index/contents/glossary, and returns a formatted text list of items.
async listCategoryItems(category: string): Promise<{ content: Array<{ type: string; text: string }> }> { const validCategories = ['index', 'contents', 'glossary']; if (!validCategories.includes(category)) { throw new Error(`Invalid category: ${category}. Must be one of: ${validCategories.join(', ')}`); } // Embedded data - geen externe bestanden nodig! const categoryData = { index: [ 'Introduction', 'SDK Contents', 'SDK Overview', 'Using The SDK', 'SDK EULA', 'Release Notes', 'Samples, Schemas, Tutorials and Primers', 'Developer Mode', 'Menus', 'The Project Editor', 'The Scenery Editor', 'The Material Editor', 'The Script Editor', 'The Aircraft Editor', 'Aircraft Debug Menu', 'The Aircraft Tab', 'The Flight Model Tab', 'The AI Tab', 'The Cockpit Tab', 'The Gameplay Tab', 'The Engines Tab', 'The Systems Tab', 'The Cameras Tab', 'The Custom Parameters Tab', 'The Visual Effects Editor', 'External Asset Creation', 'Content Configuration', 'Programming APIs', 'Additional Information', 'How To Create An Aircraft', 'World Hub' ], contents: [ 'Introduction', 'SDK Contents', 'SDK Overview', 'Using The SDK', 'SDK EULA', 'Release Notes', 'Samples, Schemas, Tutorials and Primers', 'Developer Mode', 'Menus', 'The Project Editor', 'The Scenery Editor', 'The Material Editor', 'The Script Editor', 'The Aircraft Editor', 'Aircraft Debug Menu', 'The Aircraft Tab', 'The Flight Model Tab', 'The AI Tab', 'The Cockpit Tab', 'The Gameplay Tab', 'The Engines Tab', 'The Systems Tab', 'The Cameras Tab', 'The Custom Parameters Tab', 'The Visual Effects Editor', 'External Asset Creation', 'Content Configuration', 'Programming APIs', 'Additional Information', 'How To Create An Aircraft', 'World Hub' ], glossary: [ 'ADC', 'add-ons', 'ADF', 'ADI', 'ADPCM', 'AFM', 'AGL', 'AH', 'AHRS', 'ambisonic', 'AMSL', 'AoA', 'AOC', 'API', 'APU', 'ATC', 'BGL', 'bpp', 'Camber', 'CAS', 'CFD', 'CG', 'CGL', 'Chord', 'CoL', 'dB', 'dBTP', 'DDS', 'de-crab', 'DEM', 'Dihedral', 'DME', 'DoF', 'DRM', 'EAS', 'ECU', 'EGT', 'ELT', 'EPR', 'FAF', 'FIS', 'FL', 'flaps', 'FLC', 'FOV', 'FSUIPC', 'ft', 'ftlbs', 'GA', 'Gallon', 'GDI+', 'glTF', 'GPS', 'GPWS', 'GUID', 'hp', 'hPa', 'IAF', 'IAS', 'ICAO', 'ICAO code', 'ICU', 'IFR', 'ILS', 'Incidence', 'inHg', 'ISA', 'ITT', 'kcas', 'kias', 'Knot', 'ktas', 'lbf', 'lbs', 'LDA', 'LKFS', 'LOD', 'LU', 'MAC', 'Mach', 'Makefile', 'MFD', 'MOI', 'mph', 'MSL', 'MTOW', 'N1', 'N2', 'NDB', 'nm', 'OOI', 'OSM', 'Oswald Efficiency Factor', 'Pa', 'pbh', 'PBR', 'PCM', 'Percent Over 100', 'PFD', 'PID', 'POH', 'POI', 'psf', 'psi', 'quadkey', 'Rankine', 'RNAV', 'ROC', 'RPM', 'RTO', 'RTPC', 'SDF', 'slug', 'Slug sqft', 'sqft', 'STOL', 'Sweep', 'Tacan', 'TAS', 'TCAS', 'TIN', 'TOGA', 'Twist', 'UI', 'VASI', 'VFR', 'VFS', 'VMO', 'VOR', 'WASM', 'WEP', 'Zulu Time' ] }; const items = categoryData[category as keyof typeof categoryData]; return { content: [ { type: 'text', text: items.join('\n') } ] }; } - src/index.ts:103-117 (registration)Tool registration in the ListToolsRequestHandler, defining the name, description, and input schema for 'list_category_items'.
{ name: 'list_category_items', description: 'Returns all items for a given documentation category', inputSchema: { type: 'object', properties: { category: { type: 'string', description: 'Category to list items from (index, contents, or glossary)', enum: ['index', 'contents', 'glossary'] } }, required: ['category'] } } - src/index.ts:106-116 (schema)Input schema definition for the 'list_category_items' tool, specifying the required 'category' parameter with allowed enum values.
inputSchema: { type: 'object', properties: { category: { type: 'string', description: 'Category to list items from (index, contents, or glossary)', enum: ['index', 'contents', 'glossary'] } }, required: ['category'] } - src/index.ts:183-188 (helper)Helper routing code in the CallToolRequestHandler switch statement that validates input and delegates to the documentationService handler.
case 'list_category_items': if (!args?.category) { throw new Error('Category parameter is required'); } return await this.documentationService.listCategoryItems(String(args.category));