Skip to main content
Glama
lensesio

Lenses MCP Server

by lensesio

list_topics

Retrieve detailed information about all Kafka topics in a specified environment to manage and explore data across clusters.

Instructions

Retrieve information about all topics.

Args: environment: The environment name.

Returns: List of all topics with detailed information.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
environmentYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function for the 'list_topics' tool. It makes a GET request to the API endpoint to retrieve all topics for the specified environment.
    @mcp.tool()
    async def list_topics(environment: str) -> List[Dict[str, Any]]:
        """
        Retrieve information about all topics.
        
        Args:
            environment: The environment name.
        
        Returns:
            List of all topics with detailed information.
        """
        endpoint = f"/api/v1/environments/{environment}/proxy/api/topics"
        return await api_client._make_request("GET", endpoint)
  • Top-level registration of the topics tools module, which includes the 'list_topics' tool, by invoking register_topics(mcp).
    register_topics(mcp)
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 mentions retrieval of 'detailed information' without specifying what that entails (e.g., format, pagination, permissions required, or rate limits). It lacks critical behavioral details like whether this is a safe read operation or has side effects, making it insufficient for informed use.

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 well-structured with clear sections (Args, Returns) and uses minimal sentences. It's front-loaded with the main purpose, though 'detailed information' is vague and could be more precise. Overall, it's efficient with little waste.

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 1 parameter with 0% schema coverage and an output schema present, the description adds some param semantics but lacks behavioral context (e.g., safety, permissions). The output schema handles return values, so the description doesn't need to explain those. However, for a tool with no annotations, more behavioral disclosure 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?

Schema description coverage is 0%, but the description compensates by explaining the 'environment' parameter in the Args section, adding meaning beyond the bare schema. However, it doesn't detail possible values or constraints for 'environment', leaving some ambiguity. With only 1 parameter, this is adequate but not comprehensive.

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 'Retrieve' and resource 'information about all topics', making the purpose unambiguous. It distinguishes from siblings like 'get_topic' (singular) and 'list_topic_metadata' (metadata-specific), though not explicitly named. However, it lacks the specificity of 'detailed information' being clarified, keeping it from a perfect score.

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 like 'get_topic' for a single topic or 'list_topic_metadata' for metadata-focused listing. The description only states what it does, not when it's appropriate, leaving the agent to infer usage from context without explicit direction.

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

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/lensesio/lenses-mcp'

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