OSRS MCP Server

Instructions

Input Schema

Input Schema (JSON Schema)

Implementation Reference

• index.ts:384-407 (handler)

  Shared handler for search_rowtypes and similar tools in the CallToolRequestSchema switch statement. Derives filename 'rowtypes.txt' from tool name, validates input with FileSearchSchema, checks file existence, performs search using searchFile helper, and returns paginated results.
  case "search_varptypes": case "search_varbittypes": case "search_iftypes": case "search_invtypes": case "search_loctypes": case "search_npctypes": case "search_objtypes": case "search_rowtypes": case "search_seqtypes": case "search_soundtypes": case "search_spottypes": case "search_spritetypes": case "search_tabletypes": const { query, page: filePage = 1, pageSize: filePageSize = 10 } = FileSearchSchema.parse(args); const filename = `${name.replace('search_', '')}.txt`; const filePath = path.join(DATA_DIR, filename); if (!fileExists(filename)) { return responseToString({ error: `${filename} not found in data directory` }); } const fileResults = await searchFile(filePath, query, filePage, filePageSize); return responseToString(fileResults);
• index.ts:49-53 (schema)

  FileSearchSchema: Zod schema defining input parameters (query, page, pageSize) for search_rowtypes tool, used for validation in handler and exposed in tool registration.
  const FileSearchSchema = z.object({ query: z.string().describe("The term to search for in the file"), page: z.number().int().min(1).optional().default(1).describe("Page number for pagination"), pageSize: z.number().int().min(1).max(100).optional().default(10).describe("Number of results per page") });
• index.ts:294-297 (registration)

  Registration of search_rowtypes tool in the tools list returned by ListToolsRequestSchema handler, including name, description, and inputSchema reference.
  name: "search_rowtypes", description: "Search the rowtypes.txt file for row definitions used in various interfaces.", inputSchema: convertZodToJsonSchema(FileSearchSchema), },
• index.ts:98-165 (helper)

  searchFile helper function: core implementation that reads the file line-by-line, searches case-insensitively (after replacing spaces with underscores in query), collects matching lines with line numbers, formats as key-value if possible, applies pagination, and returns structured results.
  */ async function searchFile(filePath: string, searchTerm: string, page: number = 1, pageSize: number = 10): Promise<any> { //replace spaces with underscores searchTerm = searchTerm.replace(" ", "_"); return new Promise((resolve, reject) => { if (!fs.existsSync(filePath)) { reject(new Error(`File not found: ${filePath}`)); return; } const results: {line: string, lineNumber: number}[] = []; const fileStream = fs.createReadStream(filePath); const rl = readline.createInterface({ input: fileStream, crlfDelay: Infinity }); let lineNumber = 0; rl.on('line', (line) => { lineNumber++; if (line.toLowerCase().includes(searchTerm.toLowerCase())) { results.push({ line, lineNumber }); } }); rl.on('close', () => { const totalResults = results.length; const totalPages = Math.ceil(totalResults / pageSize); const startIndex = (page - 1) * pageSize; const endIndex = startIndex + pageSize; const paginatedResults = results.slice(startIndex, endIndex); // Process the results to extract key-value pairs if possible const formattedResults = paginatedResults.map(result => { // Try to format as key-value pair (common for ID data files) const parts = result.line.split(/\s+/); if (parts.length >= 2) { const id = parts[0]; const value = parts.slice(1).join(' '); return { ...result, id, value, formatted: `${id}\t${value}` }; } return result; }); resolve({ results: formattedResults, pagination: { page, pageSize, totalResults, totalPages, hasNextPage: page < totalPages, hasPreviousPage: page > 1 } }); }); rl.on('error', (err) => { reject(err); }); }); }