Skip to main content
Glama

get_components_by_canvas

Retrieve security components associated with a specific threat model canvas to analyze and manage security controls.

Instructions

Get components for a specific canvas

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
canvas_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The MCP tool handler function for 'get_components_by_canvas', decorated with @mcp.tool(), which creates an API client instance and delegates to the client's get_components_by_canvas method, returning the result as a string.
    @mcp.tool()
    async def get_components_by_canvas(canvas_id: str) -> str:
        """Get components for a specific canvas"""
        async with create_client_from_env() as client:
            result = await client.get_components_by_canvas(canvas_id)
            return str(result)
  • The underlying API client method that implements the core logic by making an authenticated GET request to the Devici API endpoint /components/canvas/{canvas_id}.
    async def get_components_by_canvas(self, canvas_id: str) -> Dict[str, Any]:
        """Get all components for specific canvas."""
        return await self._make_request("GET", f"/components/canvas/{canvas_id}")
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states 'Get components' but doesn't clarify if this is a read-only operation, what permissions are needed, how results are returned (e.g., list format), or any rate limits. This leaves significant gaps for a tool that likely interacts with data.

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 is appropriately sized and front-loaded, making it easy to parse quickly.

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 the tool has an output schema (which should cover return values) and only one parameter, the description is minimally adequate. However, with no annotations and low schema coverage, it lacks details on behavior and usage context, making it incomplete for optimal agent guidance.

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 description mentions 'for a specific canvas', which implies the 'canvas_id' parameter is used to filter components by canvas. However, with 0% schema description coverage and only one parameter, this adds some meaning but doesn't fully compensate for the lack of schema details, such as the expected format of 'canvas_id'.

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 'Get' and the resource 'components for a specific canvas', making the purpose understandable. However, it doesn't differentiate from sibling tools like 'get_component' or 'get_components', which might retrieve components differently, so it doesn't reach the highest 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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention when to choose it over 'get_component' or 'get_components', nor does it specify prerequisites or context for usage, leaving the agent with minimal 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/sdelements/devici-mcp'

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