Skip to main content
Glama

query_entities

Search and filter entities (classes, functions, modules) in a knowledge graph by type, programming language, or name pattern using customizable parameters for precise results.

Instructions

Query entities in the knowledge graph.

Args: entity_type: Filter by entity type (class, function, module, etc.) language: Filter by programming language name_pattern: Filter by name pattern (regex) limit: Maximum number of results to return

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entity_typeNo
languageNo
limitNo
name_patternNo

Implementation Reference

  • MCP tool handler for 'query_entities'. This is the main execution function, decorated with @self.mcp.tool() which registers it as an MCP tool. It calls KnowledgeGraph.query_entities and formats the results as a string.
    @self.mcp.tool()
    def query_entities(
        entity_type: str | None = None,
        language: str | None = None,
        name_pattern: str | None = None,
        limit: int = 10,
    ) -> str:
        """Query entities in the knowledge graph.
    
        Args:
            entity_type: Filter by entity type (class, function, module, etc.)
            language: Filter by programming language
            name_pattern: Filter by name pattern (regex)
            limit: Maximum number of results to return
        """
        entities = self.knowledge.query_entities(
            entity_type=entity_type,
            language=language,
            name_pattern=name_pattern,
            limit=limit,
        )
    
        if not entities:
            return "No entities found matching the query criteria"
    
        # Format results
        output = f"Found {len(entities)} entities:\n\n"
    
        for entity in entities:
            output += f"Name: {entity.name}\n"
            output += f"Type: {entity.entity_type}\n"
    
            if entity.language:
                output += f"Language: {entity.language}\n"
    
            if entity.signature:
                output += f"Signature: {entity.signature}\n"
    
            output += f"Summary: {entity.summary}\n"
    
            if entity.observations:
                output += "Observations:\n"
                for observation in entity.observations[
                    :3
                ]:  # Limit to 3 observations
                    output += f"- {observation}\n"
    
                if len(entity.observations) > 3:
                    output += f"... and {len(entity.observations) - 3} more observations\n"
    
            output += "\n"
    
        return output
  • Core implementation of entity querying in KnowledgeGraph class. Filters entities by type, language, and name pattern using regex, with optional limit.
    def query_entities(
        self,
        entity_type: str | None = None,
        language: str | None = None,
        name_pattern: str | None = None,
        limit: int = 100,
    ) -> list[Entity]:
        """Query entities based on criteria.
    
        Args:
            entity_type: Filter by entity type
            language: Filter by programming language
            name_pattern: Filter by name pattern (regex)
            limit: Maximum number of results
    
        Returns:
            List of matching entities
        """
        results = []
    
        for entity in self.entities.values():
            # Apply filters
            if entity_type is not None and entity.entity_type != entity_type:
                continue
    
            if language is not None and entity.language != language:
                continue
    
            if name_pattern is not None:
                if not re.search(name_pattern, entity.name):
                    continue
    
            results.append(entity)
    
            if len(results) >= limit:
                break
    
        return results
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 states this is a query operation (implying read-only), but doesn't disclose important behavioral traits like authentication requirements, rate limits, error conditions, pagination behavior (beyond the 'limit' parameter), or what happens when no results match. For a query tool with zero annotation coverage, this leaves significant gaps.

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 efficiently structured with a clear purpose statement followed by a well-organized parameter explanation. Every sentence earns its place, and the information is front-loaded with the core functionality stated first.

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?

Given 4 parameters with no schema descriptions and no output schema, the description adequately covers parameter semantics but lacks behavioral context and output information. For a query tool in a knowledge graph system with multiple sibling tools, more guidance about when to use it and what results look like would improve completeness.

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?

With 0% schema description coverage, the description compensates well by explaining all 4 parameters in the Args section. It clarifies that 'entity_type' filters by categories like class/function/module, 'language' filters by programming language, 'name_pattern' uses regex, and 'limit' controls result count. This adds meaningful context beyond the bare schema.

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 verb ('Query') and resource ('entities in the knowledge graph'), making the purpose understandable. However, it doesn't distinguish this tool from siblings like 'get_entity_details' or 'query_patterns', which appear to be related query operations on the same knowledge graph 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?

No guidance is provided on when to use this tool versus alternatives. With siblings like 'get_entity_details' (likely for single entities) and 'query_patterns' (for patterns rather than entities), the description offers no comparison or context about appropriate use cases.

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/sarathsp06/sourcesage'

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