reference-events

Instructions

Implementation Reference

• src/index.ts:21-43 (handler)

  Handler function that executes the tool: reads the 'reference/events.md' file content via readMarkdownFile and returns it as MCP content block or error.

  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)

  Tool registration via dynamic loop over docFiles config, registering server.tool('reference-events', 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:76-81 (schema)

  Tool configuration/schema defining name 'reference-events', target file 'reference/events.md', and description.

  {
    folder: 'reference',
    file: 'events.md',
    name: 'reference-events',
    description: 'Turbo events reference - comprehensive list of all Turbo events fired during navigation, form submissions, frame updates, and stream processing for lifecycle management'
  },

• src/documentReader.ts:14-61 (helper)

  Supporting helper to read markdown docs from cache, GitHub raw, or local fallback, invoked with 'reference/events.md' for this tool.

  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})`);
      }
    }
  }