Skip to main content
Glama

search_users

Find users in the Devici security platform by searching specific fields with text queries to manage 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 main MCP tool handler for 'search_users'. It is registered via @mcp.tool() decorator and proxies the call to the Devici API client, returning the result as 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 API client method that makes the HTTP request to the Devici API endpoint for searching users.
    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}")
  • The @mcp.tool() decorator registers the search_users function as an MCP tool with the FastMCP server instance.
    @mcp.tool()
Behavior1/5

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

No annotations are provided, so the description carries full burden for behavioral disclosure. It only states the basic function without mentioning permissions needed, rate limits, pagination, sorting, case sensitivity, or what happens on no matches. This is inadequate for a search tool with zero annotation coverage.

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 with zero wasted words. It's appropriately sized for a simple tool and front-loads the core action and parameters.

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?

Given 2 parameters with 0% schema coverage, no annotations, and an output schema (which reduces need to describe returns), the description is incomplete. It doesn't address key contextual aspects like valid field values, search behavior, or error conditions, making it insufficient for reliable tool use.

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 parameters 'field' and 'text' are undocumented in the schema. The description adds minimal value by naming them but doesn't explain what fields are valid (e.g., 'name', 'email'), what text matching is used, or format requirements. It partially compensates but leaves critical gaps.

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 the action (search) and resource (users) but lacks specificity about what fields are searchable or what kind of search is performed (exact match, partial, etc.). It distinguishes from siblings like 'get_user' and 'get_users' by implying a filtered search, but doesn't clearly differentiate from potential search alternatives.

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 retrieve all users) or 'get_user' (which might retrieve a specific user by ID). The description implies a filtered search but doesn't specify prerequisites, constraints, or when-not-to-use scenarios.

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