Skip to main content
Glama
WaterSippin

OSRS MCP Server

Official
by WaterSippin

search_rowtypes

Search and retrieve row definitions from the rowtypes.txt file in the Old School RuneScape game data. Utilize this tool to find specific interface data with paginated results.

Instructions

Search the rowtypes.txt file for row definitions used in various interfaces.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination
pageSizeNoNumber of results per page
queryYesThe term to search for in the file

Implementation Reference

  • index.ts:342-344 (registration)
    Registration of the search_rowtypes tool in the getToolDefinitions() function, which provides the tool name and description for the listTools MCP request.
        name: "search_rowtypes",
        description: "Search the rowtypes.txt file for row definitions used in various interfaces.",
    },
  • Input schema (FileSearchSchema) used for validating parameters of search_rowtypes and other search_* tools.
    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")
    });
  • Core handler logic executed for search_rowtypes (dispatched at line 438 in the switch statement). Parses arguments, derives 'rowtypes.txt' filename, checks file existence, and calls searchFile helper to perform the search with pagination.
    const fileSearchArgs = getSchemaForTool(name).parse(args) as { query: string; page?: number; pageSize?: number };
    const { query, page: filePage = 1, pageSize: filePageSize = 10 } = fileSearchArgs;
    const filename = `${name.replace('search_', '')}.txt`;
    const filePath = path.join(getDataDir(), filename);
    
    if (!fileExists(filename)) {
        return responseToString({ error: `${filename} not found in data directory` });
    }
    
    const fileResults = await searchFile(filePath, query, filePage, filePageSize);
    return responseToString(fileResults);
  • Helper function implementing the file search logic: streams the rowtypes.txt file, matches query case-insensitively, extracts ID and value, paginates results. Called by the search_rowtypes handler.
    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);
            });
        });
    }
  • Schema selector in getSchemaForTool() that returns FileSearchSchema for search_rowtypes.
            if (toolName.startsWith("search_")) {
                return FileSearchSchema;
            }
            throw new Error(`Unknown tool: ${toolName}`);
    }

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden but only states it's a search operation. It doesn't disclose whether this is read-only, if it has rate limits, what authentication might be needed, or what happens on failure. For a search tool with zero annotation coverage, this is insufficient behavioral disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, clear sentence that efficiently conveys the core purpose. It's appropriately sized for a search tool, though it could be slightly more front-loaded with key usage information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a search tool with no annotations and no output schema, the description provides basic purpose but lacks important context about return format, error handling, or behavioral constraints. The 100% schema coverage helps, but overall completeness is only adequate.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents all three parameters. The description adds no additional parameter semantics beyond implying a text search in a specific file. This meets the baseline for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('search') and target resource ('rowtypes.txt file for row definitions'), making the purpose understandable. It doesn't explicitly differentiate from sibling tools like 'search_iftypes' or 'search_invtypes', but the specific file reference provides some distinction.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'search_data_file' or other search_* tools. It mentions 'used in various interfaces' but gives no practical usage context or prerequisites for selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.