reference-values
Access API references for value definitions, type coercion, and reactive data binding in Stimulus JS. Simplify HTML and JavaScript interactions using detailed documentation and change callbacks.
Instructions
Values API reference - covers value definitions, type coercion, change callbacks, and using values for reactive data binding between HTML and JavaScript
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:21-43 (handler)The handler function for the 'reference-values' tool. It reads the markdown content from the specified path using readMarkdownFile, formats it as an MCP content block of type 'text', and handles errors by returning an error message in the same format.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)Registers the 'reference-values' tool (along with other doc tools) on the MCP server by iterating over the docFiles configuration array and invoking server.tool with the tool's name, description, and handler function.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:101-104 (schema)Configuration entry defining the metadata for the 'reference-values' tool, including its name, description, and the source markdown file path.folder: 'reference', file: 'values.md', name: 'reference-values', description: 'Values API reference - covers value definitions, type coercion, change callbacks, and using values for reactive data binding between HTML and JavaScript' }
- src/documentReader.ts:14-61 (helper)Helper function that fetches the markdown content for a given filename, preferring cached GitHub content based on main branch commit, falling back to direct GitHub raw fetch with caching, and finally local file read. Used by all doc tool handlers.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})`); } } }