Skip to main content
Glama

search_workflows

Search workflow executions in Netflix Conductor using query syntax to filter by type, status, or other criteria for troubleshooting and management.

Instructions

Advanced search for workflow executions using query syntax. Supports complex queries with multiple criteria.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesQuery string (e.g., 'workflowType=MyWorkflow AND status=FAILED')
startNoStart index for pagination (default: 0)
sizeNoNumber of results to return (default: 100)
sortNoSort field and order (e.g., 'startTime:DESC')

Implementation Reference

  • The handler function for the 'search_workflows' tool. It destructures input arguments, constructs query parameters, calls the Conductor API endpoint '/workflow/search-v2', and returns the response as formatted JSON text.
    case "search_workflows": {
      const { query, start = 0, size = 100, sort } = args as any;
      
      const params: any = {
        start,
        size,
        query,
      };
      
      if (sort) params.sort = sort;
      
      const response = await conductorClient.get("/workflow/search-v2", { params });
      
      return {
        content: [
          {
            type: "text",
            text: JSON.stringify(response.data, null, 2),
          },
        ],
      };
    }
  • The input schema definition for the 'search_workflows' tool, specifying properties for query, pagination (start, size), and sorting.
    inputSchema: {
      type: "object",
      properties: {
        query: {
          type: "string",
          description: "Query string (e.g., 'workflowType=MyWorkflow AND status=FAILED')",
        },
        start: {
          type: "number",
          description: "Start index for pagination (default: 0)",
        },
        size: {
          type: "number",
          description: "Number of results to return (default: 100)",
        },
        sort: {
          type: "string",
          description: "Sort field and order (e.g., 'startTime:DESC')",
        },
      },
      required: ["query"],
    },
  • src/index.ts:364-390 (registration)
    The complete tool registration object for 'search_workflows' in the tools array, which is returned by the list_tools handler.
    {
      name: "search_workflows",
      description:
        "Advanced search for workflow executions using query syntax. Supports complex queries with multiple criteria.",
      inputSchema: {
        type: "object",
        properties: {
          query: {
            type: "string",
            description: "Query string (e.g., 'workflowType=MyWorkflow AND status=FAILED')",
          },
          start: {
            type: "number",
            description: "Start index for pagination (default: 0)",
          },
          size: {
            type: "number",
            description: "Number of results to return (default: 100)",
          },
          sort: {
            type: "string",
            description: "Sort field and order (e.g., 'startTime:DESC')",
          },
        },
        required: ["query"],
      },
    },
  • Helper function formatError provides a specific suggestion mentioning 'search_workflows' when Elasticsearch errors occur.
    if (message.includes("Elasticsearch")) {
      suggestion = "\n\nšŸ’” Suggestion: Elasticsearch is not configured or unavailable. Try using list_workflows instead of search_workflows.";
    } else {
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 'advanced search' and 'complex queries' but lacks critical details such as pagination behavior (implied by parameters but not described), rate limits, authentication requirements, or what the output looks like. This is inadequate for a search tool with no 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 highly concise with two sentences that efficiently convey the core functionality and key features. It's front-loaded with the main purpose and wastes no words, making it easy for an agent to parse quickly.

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 the tool's complexity (search with query syntax) and lack of annotations and output schema, the description is incomplete. It doesn't explain return values, error conditions, or behavioral nuances like how pagination works in practice. For a search tool with no structured output information, this leaves significant gaps for an agent.

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 schema description coverage is 100%, so the schema already documents all four parameters thoroughly. The description adds minimal value beyond the schema by hinting at query syntax complexity but doesn't provide additional semantics or examples beyond what's in the schema descriptions. Baseline 3 is appropriate when schema does the heavy lifting.

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 tool's purpose as 'Advanced search for workflow executions using query syntax' with the verb 'search' and resource 'workflow executions'. It distinguishes from siblings like 'list_workflows' by emphasizing advanced query capabilities, though it doesn't explicitly name the sibling for comparison.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage context through 'Advanced search' and 'complex queries with multiple criteria', suggesting this is for detailed filtering beyond basic listing. However, it doesn't explicitly state when to use this versus alternatives like 'list_workflows' or provide clear exclusions, leaving some ambiguity.

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/opensensor/conductor-mcp'

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