Skip to main content
Glama
itential

Itential MCP Server

Official
by itential

get_job_metrics_for_workflow

Retrieve job execution metrics for a specific workflow, providing targeted insights into performance and execution statistics.

Instructions

Get the job metrics for the specified workflow from Workflow Engine.

Retrieves job execution metrics filtered by a specific workflow name, providing targeted insights into the performance and execution statistics for jobs within that particular workflow.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesThe name of the workflow to get the job metrics for

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYesResponse model for job metrics collection endpoints. This Pydantic RootModel provides a standardized response format for API endpoints that return collections of job metrics from the Itential Platform workflow engine. It wraps a list of JobMetricElement objects, enabling type-safe handling of job metrics data across the platform. The root model pattern allows the response to be treated as a list while maintaining proper validation and serialization capabilities for the contained job metric elements. Args: root: List of JobMetricElement objects containing job performance data. Defaults to an empty list if not provided. Attributes: root (List[JobMetricElement]): Collection of job metric elements with performance and completion statistics for workflow monitoring Example: Creating a response with multiple job metrics: >>> job1 = JobMetricElement(_id="job1", workflow="wf1", metrics=[], ... jobsComplete=10, totalRunTime=100.0) >>> job2 = JobMetricElement(_id="job2", workflow="wf2", metrics=[], ... jobsComplete=20, totalRunTime=250.5) >>> response = GetJobMetricsResponse([job1, job2]) >>> print(len(response.root)) # 2 >>> print(response.root[0].jobs_complete) # 10 Notes: - Uses default_factory=list to create empty collections when needed - Supports iteration and indexing through the root attribute - Maintains type safety for all contained JobMetricElement objects
Behavior3/5

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

With no annotations, the description bears the burden of disclosing behavior. It uses 'Get' and 'Retrieves,' indicating a read-only operation, and adds context about providing performance and execution statistics. However, it does not detail limitations, error conditions, or whether any side effects exist. For a simple read tool, this is adequate but not enriched.

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 two sentences, front-loaded with the core purpose and followed by a brief elaboration. It is concise with no fluff, though the second sentence somewhat repeats the first. This is efficient and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With only one parameter, a clear description, and an output schema provided, the description covers the essential context. It explains what the tool does and how it filters. Given the tool's simplicity, the lack of additional details about return values or edge cases is acceptable, but there is slight room for more specificity about the metrics content.

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 input schema already provides 100% coverage for the single parameter 'name' with a description. The tool description restates the filtering by workflow name but adds no additional semantic meaning beyond what the schema already offers, so the baseline score of 3 applies.

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

Purpose5/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 with a specific verb ('Get'), resource ('job metrics'), and scope ('for the specified workflow'). It distinguishes itself from sibling tools like get_job_metrics by explicitly mentioning filtering by workflow name, making it clear this is a scoped variant.

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

Usage Guidelines4/5

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

The description provides clear context for when to use this tool: when you need job metrics for a specific workflow. It doesn't explicitly mention alternatives or exclusions, but the filtering by workflow name implies the appropriate scenario. This is more than a vague implication, so it earns a 4.

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/itential/itential-mcp'

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