Skip to main content
Glama

search_tabletypes

Find interface tab definitions in the tabletypes.txt file by searching with a query. Supports pagination to manage results efficiently. Use this tool to locate specific game data entries.

Instructions

Search the tabletypes.txt file for interface tab definitions.

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 logic for search_tabletypes and other search_* tools. Parses arguments, determines filename 'tabletypes.txt', checks existence, and calls searchFile helper.
    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);
  • Input schema (FileSearchSchema) used by search_tabletypes for validating query, page, and pageSize parameters.
    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:318-322 (registration)
    Tool registration in listTools handler, specifying name, description, and input schema.
    {
        name: "search_tabletypes",
        description: "Search the tabletypes.txt file for interface tab definitions.",
        inputSchema: convertZodToJsonSchema(FileSearchSchema),
    },
  • Core searchFile helper function that performs case-insensitive search in the specified file, supports pagination, and formats results as key-value pairs.
    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?

No annotations are provided, so the description carries the full burden of behavioral disclosure. While it mentions searching a specific file, it doesn't describe what the search returns (e.g., matches, snippets, full definitions), whether results are paginated (though the schema suggests this), error conditions, or performance characteristics. The description is minimal and leaves key behavioral aspects unspecified.

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

Conciseness5/5

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

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It's appropriately sized for a search tool and front-loads the essential information (search action and target). Every word earns its place.

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

Completeness2/5

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

Given the complexity of a search operation with pagination parameters and no output schema, the description is incomplete. It doesn't explain what the search returns (e.g., match details, relevance scores, full definitions), how results are structured, or what happens when no matches are found. For a search tool with three parameters and no output schema, more context about the return value is needed.

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?

The input schema has 100% description coverage, with clear documentation for all three parameters (query, page, pageSize). The description adds no additional parameter semantics beyond what's already in the schema, which is acceptable given the comprehensive schema coverage. The baseline score of 3 reflects adequate but not enhanced parameter understanding.

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 the target resource ('tabletypes.txt file for interface tab definitions'), which is specific and unambiguous. However, it doesn't explicitly differentiate this tool from its many sibling search tools (e.g., search_iftypes, search_invtypes), which all appear to search different file types in a similar system.

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. With 17 sibling tools including many other 'search_*' tools (e.g., search_iftypes, search_invtypes), there's no indication of what makes this tool distinct or when it should be chosen over similar search tools for different file types.

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