Skip to main content
Glama

query_patterns

Discover and analyze code patterns across programming languages within a knowledge graph. Filter results by language or pattern name to enhance code understanding and retrieval.

Instructions

Query code patterns in the knowledge graph.

Args: language: Filter by programming language pattern_name: Filter by pattern name

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
languageNo
pattern_nameNo

Implementation Reference

  • The handler function for the 'query_patterns' MCP tool. It queries the knowledge graph for patterns matching the given language and name filters, then formats and returns a detailed string summary of the matching patterns.
    @self.mcp.tool()
    def query_patterns(
        language: str | None = None, pattern_name: str | None = None
    ) -> str:
        """Query code patterns in the knowledge graph.
    
        Args:
            language: Filter by programming language
            pattern_name: Filter by pattern name
        """
        patterns = self.knowledge.find_patterns(
            name=pattern_name, language=language
        )
    
        if not patterns:
            return "No patterns found matching the query criteria"
    
        # Format results
        output = f"Found {len(patterns)} patterns:\n\n"
    
        for pattern in patterns:
            output += f"Name: {pattern.name}\n"
    
            if pattern.language:
                output += f"Language: {pattern.language}\n"
    
            output += f"Description: {pattern.description}\n"
    
            if pattern.example:
                output += "Example:\n"
                output += "```\n"
                output += pattern.example
                output += "\n```\n"
    
            output += "\n"
    
        return output

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries full burden. It only says 'Query', implying a read operation, but lacks detail on performance, side effects, or error behavior.

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?

Extremely concise: one sentence for the tool purpose, then two lines for parameters. No unnecessary words or repetition.

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?

With no output schema or behavioral annotations, the description omits return format, filtering behavior, and other contextual details needed for complete understanding.

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

Parameters4/5

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

Schema description coverage is 0%, but the description adds meaningful explanations for both parameters ('Filter by programming language', 'Filter by pattern name'), compensating for the schema gap.

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 tool queries code patterns in the knowledge graph, distinguishing it from siblings like query_entities. The verb 'Query' and resource 'code patterns' are specific.

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?

No guidance on when to use this tool versus alternatives like query_entities. The description merely states what it does without context or exclusions.

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