Skip to main content
Glama

List Scheduled Maintenance States

list_scheduled_maintenance_states
Read-only

List Scheduled Maintenance States, with the total count.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_scheduled_maintenance_states"
  }
}

Input Schema

NameRequiredDescriptionDefault
skipNo
sortNoFor example {"createdAt":"DESC"}.
limitNoDefault: 10, maximum: 100.
queryNoA field's value, or an operator such as {"_type":"GreaterThan","value":...}. Fields and operators: oneuptime_describe_resource.
selectNoOmit for all.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • changedInput schema / properties / limit / description
      Previous value: -"Records to return. Default: 10, maximum: 100."New value: +"Default: 10, maximum: 100."
    • changedInput schema / properties / query / description
      Previous value: -"Filter. Each field takes a value (exact match) or an operator, such as {\"_type\":\"GreaterThan\",\"value\":...}. Fields and operators: oneuptime_describe_resource."New value: +"A field's value, or an operator such as {\"_type\":\"GreaterThan\",\"value\":...}. Fields and operators: oneuptime_describe_resource."
    • changedInput schema / properties / select / description
      Previous value: -"Field names to return. Omit for all readable fields."New value: +"Omit for all."
    • removedInput schema / properties / skip / description
      Removed value: -"Records to skip. Default: 0."
    • changedInput schema / properties / sort / description
      Previous value: -"Fields to sort by. Example: {\"createdAt\":\"DESC\"}."New value: +"For example {\"createdAt\":\"DESC\"}."
  2. Changed9 schema fields changed
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of records to return. Default: 10, Maximum: 100."New value: +"Records to return. Default: 10, maximum: 100."
    • changedInput schema / properties / query / additionalProperties
      Previous value: -falseNew value: +true
    • changedInput schema / properties / query / description
      Previous value: -"Filter criteria for Scheduled Maintenance States. Each field accepts a direct value (exact match) or an operator object {\"_type\": \"<Operator>\", \"value\": ...}. Operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween (numbers/dates), Search (partial text), Includes (array of values). Example — items from the last 24 hours: {\"createdAt\": {\"_type\": \"GreaterThan\", \"value\": \"2026-01-01T00:00:00.000Z\"}}."New value: +"Filter. Each field takes a value (exact match) or an operator, such as {\"_type\":\"GreaterThan\",\"value\":...}. Fields and operators: oneuptime_describe_resource."
    • removedInput schema / properties / query / properties
      Removed value: -{
      -  "_id": {
      -    "description": "Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      -    },
      -    "type": "object"
      -  },
      -  "archivedAt": {
      -    "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": "2023-01-01T00:00:00.000Z"
      -    },
      -    "type": "object"
      -  },
      -  "archivedByUserId": {
      -    "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      -    },
      -    "type": "object"
      -  },
      -  "color": {
      -    "description": "Query operators for color field of type Color. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": "example_value_1"
      -    },
      -    "type": "object"
      -  },
      -  "createdAt": {
      -    "description": "Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": "2023-01-01T00:00:00.000Z"
      -    },
      -    "type": "object"
      -  },
      -  "createdByUserId": {
      -    "description": "Query operators for createdByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      -    },
      -    "type": "object"
      -  },
      -  "deletedAt": {
      -    "description": "Query operators for deletedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": "2023-01-01T00:00:00.000Z"
      -    },
      -    "type": "object"
      -  },
      -  "deletedByUserId": {
      -    "description": "Query operators for deletedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      -    },
      -    "type": "object"
      -  },
      -  "description": {
      -    "description": "Query operators for description field of type Long Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": "example_value_1"
      -    },
      -    "type": "object"
      -  },
      -  "isArchived": {
      -    "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": true
      -    },
      -    "type": "object"
      -  },
      -  "isEndedState": {
      -    "description": "Query operators for isEndedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": true
      -    },
      -    "type": "object"
      -  },
      -  "isOngoingState": {
      -    "description": "Query operators for isOngoingState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": true
      -    },
      -    "type": "object"
      -  },
      -  "isResolvedState": {
      -    "description": "Query operators for isResolvedState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": true
      -    },
      -    "type": "object"
      -  },
      -  "isScheduledState": {
      -    "description": "Query operators for isScheduledState field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": true
      -    },
      -    "type": "object"
      -  },
      -  "name": {
      -    "description": "Query operators for name field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Search, Includes",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": "John Doe"
      -    },
      -    "type": "object"
      -  },
      -  "order": {
      -    "description": "Query operators for order field of type Small Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": 10
      -    },
      -    "type": "object"
      -  },
      -  "projectId": {
      -    "description": "Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      -    },
      -    "type": "object"
      -  },
      -  "slug": {
      -    "description": "Query operators for slug field of type Slug. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": "example_value_1"
      -    },
      -    "type": "object"
      -  },
      -  "updatedAt": {
      -    "description": "Query operators for updatedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": "2023-01-01T00:00:00.000Z"
      -    },
      -    "type": "object"
      -  },
      -  "version": {
      -    "description": "Query operators for version field of type Number. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween",
      -    "example": {
      -      "_type": "EqualTo",
      -      "value": 50
      -    },
      -    "type": "object"
      -  }
      -}
    • changedInput schema / properties / select / description
      Previous value: -"Optional: field names to return for each Scheduled Maintenance State (e.g. [\"_id\", \"name\"]). Omit to get all readable fields."New value: +"Field names to return. Omit for all readable fields."
    • changedInput schema / properties / skip / description
      Previous value: -"Number of records to skip for pagination. Default: 0. Example: skip=10 to start from the 11th record."New value: +"Records to skip. Default: 0."
    • changedInput schema / properties / sort / additionalProperties
      Previous value: -falseNew value: +{
      +  "enum": [
      +    "ASC",
      +    "DESC"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / sort / description
      Previous value: -"Sort order for results. Use \"ASC\" for ascending or \"DESC\" for descending. Example: {\"createdAt\": \"DESC\"} to sort by newest first."New value: +"Fields to sort by. Example: {\"createdAt\":\"DESC\"}."
    • removedInput schema / properties / sort / properties
      Removed value: -{
      -  "_id": {
      -    "description": "Sort order for _id field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "archivedAt": {
      -    "description": "Sort order for archivedAt field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "archivedByUserId": {
      -    "description": "Sort order for archivedByUserId field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "createdAt": {
      -    "description": "Sort order for createdAt field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "createdByUserId": {
      -    "description": "Sort order for createdByUserId field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "deletedAt": {
      -    "description": "Sort order for deletedAt field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "deletedByUserId": {
      -    "description": "Sort order for deletedByUserId field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "description": {
      -    "description": "Sort order for description field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "isArchived": {
      -    "description": "Sort order for isArchived field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "isEndedState": {
      -    "description": "Sort order for isEndedState field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "isOngoingState": {
      -    "description": "Sort order for isOngoingState field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "isResolvedState": {
      -    "description": "Sort order for isResolvedState field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "isScheduledState": {
      -    "description": "Sort order for isScheduledState field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "name": {
      -    "description": "Sort order for name field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "projectId": {
      -    "description": "Sort order for projectId field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "slug": {
      -    "description": "Sort order for slug field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "updatedAt": {
      -    "description": "Sort order for updatedAt field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  },
      -  "version": {
      -    "description": "Sort order for version field",
      -    "enum": [
      -      "ASC",
      -      "DESC"
      -    ],
      -    "example": "ASC",
      -    "type": "string"
      -  }
      -}
  3. Changed6 schema fields changed
    • addedInput schema / properties / query / properties / archivedAt
      Added value: +{
      +  "description": "Query operators for archivedAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, InBetween",
      +  "example": {
      +    "_type": "EqualTo",
      +    "value": "2023-01-01T00:00:00.000Z"
      +  },
      +  "type": "object"
      +}
    • addedInput schema / properties / query / properties / archivedByUserId
      Added value: +{
      +  "description": "Query operators for archivedByUserId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull, Includes",
      +  "example": {
      +    "_type": "EqualTo",
      +    "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      +  },
      +  "type": "object"
      +}
    • addedInput schema / properties / query / properties / isArchived
      Added value: +{
      +  "description": "Query operators for isArchived field of type Boolean. Supported operators: EqualTo, NotEqual, IsNull, NotNull, EqualToOrNull",
      +  "example": {
      +    "_type": "EqualTo",
      +    "value": true
      +  },
      +  "type": "object"
      +}
    • addedInput schema / properties / sort / properties / archivedAt
      Added value: +{
      +  "description": "Sort order for archivedAt field",
      +  "enum": [
      +    "ASC",
      +    "DESC"
      +  ],
      +  "example": "ASC",
      +  "type": "string"
      +}
    • addedInput schema / properties / sort / properties / archivedByUserId
      Added value: +{
      +  "description": "Sort order for archivedByUserId field",
      +  "enum": [
      +    "ASC",
      +    "DESC"
      +  ],
      +  "example": "ASC",
      +  "type": "string"
      +}
    • addedInput schema / properties / sort / properties / isArchived
      Added value: +{
      +  "description": "Sort order for isArchived field",
      +  "enum": [
      +    "ASC",
      +    "DESC"
      +  ],
      +  "example": "ASC",
      +  "type": "string"
      +}
  4. First observed

TDQS

C2.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered by structured data. The description adds one genuinely new behavioral fact beyond annotations, namely that the response includes a total count, which is useful for pagination reasoning. It still says nothing about ordering defaults, pagination behavior, or result shape beyond the count.

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?

It is a single front-loaded sentence with zero filler, which is structurally clean. The terseness borders on under-specification rather than wasteful verbosity, so it earns a 4 rather than a 5.

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?

For a five-parameter list tool with nested objects (sort, query), no output schema, and many near-identical siblings, the description is far too thin. It supplies no explanation of what a scheduled maintenance state represents, no filtering hints beyond what the schema provides, and no guidance on result structure other than the total count.

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?

Schema description coverage is 80%, so skip, sort, limit, query, and select are largely documented in the schema itself (limit even carries the default of 10 and maximum of 100, and query points to oneuptime_describe_resource). The description contributes no additional parameter meaning, which is the expected baseline of 3 at this coverage level.

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 names a specific verb and resource ("List Scheduled Maintenance States") and adds that a total count is included, so the operation is identifiable. However, it does nothing to distinguish this from closely related siblings such as list_scheduled_maintenance_state_timelines, list_scheduled_maintenance_events, or count_scheduled_maintenance_states, leaving the agent to infer which entity type applies.

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?

There is no when-to-use guidance at all: no mention of when to prefer this list tool over count_scheduled_maintenance_states or list_scheduled_maintenance_state_timelines, and no prerequisites or context requirements. The agent must guess the usage boundary purely from the name.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.