Skip to main content
Glama

search_rowtypes

Locate row definitions within the rowtypes.txt file to identify interface components in Old School RuneScape. Input a search term, specify page number, and set results per page for precise querying.

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

  • 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);
  • 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),
    },
  • 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);
            });
        });
    }
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.

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/JayArrowz/mcp-osrs'

If you have feedback or need assistance with the MCP directory API, please join our Discord server