reference-controllers
Explore the Controller API reference to understand lifecycle management, scopes, nested controllers, cross-controller event communication, and registration patterns within Stimulus JS.
Instructions
Controller API reference - covers controller lifecycle, scopes, nested controllers, cross-controller communication with events, and registration patterns
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:21-43 (handler)The core handler function for the 'reference-controllers' tool (shared across all doc tools). It reads the markdown file 'reference/controllers.md' using readMarkdownFile and returns its content as MCP content block, with error handling.async () => { try { const content = await readMarkdownFile(path.join(folder, file)); return { content: [ { type: "text", text: content } ] }; } catch (error) { const errorMessage = error instanceof Error ? error.message : String(error); return { content: [ { type: "text", text: `Error reading ${file}: ${errorMessage}` } ] }; } }
- src/index.ts:17-45 (registration)Dynamic registration of all documentation tools, including 'reference-controllers', by iterating over docFiles config and calling server.tool(name, description, handler).docFiles.forEach(({ folder, file, name, description }) => { server.tool( name, description, async () => { try { const content = await readMarkdownFile(path.join(folder, file)); return { content: [ { type: "text", text: content } ] }; } catch (error) { const errorMessage = error instanceof Error ? error.message : String(error); return { content: [ { type: "text", text: `Error reading ${file}: ${errorMessage}` } ] }; } } ); });
- src/config.ts:70-74 (schema)Configuration schema entry for the 'reference-controllers' tool, specifying its name, description, folder, and source markdown file.{ folder: 'reference', file: 'controllers.md', name: 'reference-controllers', description: 'Controller API reference - covers controller lifecycle, scopes, nested controllers, cross-controller communication with events, and registration patterns' },
- src/documentReader.ts:14-61 (helper)Helper function that implements the file reading logic: fetches from GitHub raw content with caching using commit SHA, falls back to local file if needed.export async function readMarkdownFile(filename: string): Promise<string> { const filePath = path.join(docsFolder, filename); if (!filePath.startsWith(docsFolder)) { throw new Error("Invalid file path"); } // Get current commit info if we don't have it yet if (!mainBranchInfo) { try { const commitInfo = await fetchMainBranchInformation(); const cacheKey = `${commitInfo.sha.substring(0, 7)}-${commitInfo.timestamp}`; mainBranchInfo = { ...commitInfo, cacheKey }; } catch (shaError) { console.error('Failed to get GitHub commit info, falling back to direct fetch'); } } // Try to read from cache first if we have commit info if (mainBranchInfo) { const cachedFilePath = path.join(cacheFolder, mainBranchInfo.cacheKey, filename); try { const content = await fs.promises.readFile(cachedFilePath, "utf-8"); console.error(`Using cached content for ${mainBranchInfo.cacheKey}: ${filename}`); return content; } catch (cacheError) { // Cache miss, continue to fetch from GitHub } } // Fetch from GitHub try { return await fetchFromGitHub(filename, mainBranchInfo?.cacheKey); } catch (githubError) { console.error(`GitHub fetch failed: ${githubError}, attempting to read from local files...`); // Fallback: read from local files try { return await fs.promises.readFile(filePath, "utf-8"); } catch (localError) { const githubErrorMessage = githubError instanceof Error ? githubError.message : String(githubError); const localErrorMessage = localError instanceof Error ? localError.message : String(localError); throw new Error(`Failed to read file from GitHub (${githubErrorMessage}) and locally (${localErrorMessage})`); } } }