Skip to main content
Glama

search_users

Find users in the Devici threat modeling platform by searching specific fields with text queries to manage user access and permissions.

Instructions

Search users by field and text

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldYes
textYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The MCP tool handler for 'search_users'. It is registered via @mcp.tool() decorator and executes the tool logic by creating an API client context and calling its search_users method, converting the result to string.
    @mcp.tool()
    async def search_users(field: str, text: str) -> str:
        """Search users by field and text"""
        async with create_client_from_env() as client:
            result = await client.search_users(field, text)
            return str(result)
  • Supporting method in the DeviciAPIClient class that implements the core search functionality by making an authenticated GET request to the Devici API's user search endpoint.
    async def search_users(self, field: str, text: str) -> Dict[str, Any]:
        """Search users by field and text."""
        return await self._make_request("GET", f"/users/search/field={field}&text={text}")
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 mentions searching but doesn't describe key traits like whether it's read-only (implied by 'search'), what permissions are required, if there are rate limits, pagination behavior, or the format of results. This leaves significant gaps for an agent to understand how to invoke it effectively.

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 extremely concise with a single sentence, 'Search users by field and text', which is front-loaded and wastes no words. It efficiently conveys the core action, though this brevity contributes to gaps in other dimensions.

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 likely defines return values), the description doesn't need to explain results. However, with 2 parameters, 0% schema coverage, and no annotations, the description is incomplete—it lacks details on parameter usage, behavioral context, and differentiation from siblings. It's minimally adequate but has clear gaps.

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

Parameters2/5

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

Schema description coverage is 0%, so the schema provides no details about parameters. The description adds minimal semantics by naming 'field' and 'text' but doesn't explain what fields are valid (e.g., 'name', 'email'), what text matching is used, or any constraints. This insufficiently compensates for the lack of schema documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Search users by field and text' states a clear verb ('search') and resource ('users'), but it's vague about what constitutes a 'field' and what type of search is performed (e.g., exact match, partial, case-sensitive). It doesn't distinguish this tool from sibling 'get_users' or 'get_user', leaving ambiguity about when to use each.

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_users' (which might list all users) or 'get_user' (which might fetch a specific user by ID). The description implies a filtered search but doesn't specify contexts or exclusions, such as whether it's for admin-only access or specific 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

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/geoffwhittington/devici-mcp'

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