Skip to main content
Glama
shipmail-to

shipmail-mcp

Set Mailbox Rules

shipmail_set_mailbox_rules
DestructiveIdempotent

Replace all deterministic server-side inbox rules for a mailbox. First retrieve existing rules to retain those that should stay.

Instructions

Replace every deterministic server-side inbox rule for a mailbox. Call shipmail_get_mailbox_rules first and preserve any rules that should remain.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesShipMail resource ID.
rulesYes
idempotency_keyNoOptional idempotency key. If omitted, the MCP server generates one for POST tools.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
rulesYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed12 schema fields changedv0.1.10
    • addedInput schema / $defs
      Added value: +{
      +  "__schema0": {
      +    "anyOf": [
      +      {
      +        "properties": {
      +          "type": {
      +            "enum": [
      +              "from_is",
      +              "from_contains",
      +              "recipient_is",
      +              "plus_tag_is",
      +              "subject_contains"
      +            ],
      +            "type": "string"
      +          },
      +          "value": {
      +            "maxLength": 256,
      +            "minLength": 1,
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type",
      +          "value"
      +        ],
      +        "type": "object"
      +      },
      +      {
      +        "properties": {
      +          "type": {
      +            "enum": [
      +              "has_attachment",
      +              "list_unsubscribe_exists"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type"
      +        ],
      +        "type": "object"
      +      },
      +      {
      +        "properties": {
      +          "conditions": {
      +            "items": {
      +              "$ref": "#/$defs/__schema0"
      +            },
      +            "maxItems": 10,
      +            "minItems": 1,
      +            "type": "array"
      +          },
      +          "match_mode": {
      +            "enum": [
      +              "all",
      +              "any"
      +            ],
      +            "type": "string"
      +          },
      +          "type": {
      +            "const": "group",
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type",
      +          "match_mode",
      +          "conditions"
      +        ],
      +        "type": "object"
      +      }
      +    ]
      +  }
      +}
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / definitions
      Removed value: -{
      -  "__schema0": {
      -    "anyOf": [
      -      {
      -        "properties": {
      -          "type": {
      -            "enum": [
      -              "from_is",
      -              "from_contains",
      -              "recipient_is",
      -              "plus_tag_is",
      -              "subject_contains"
      -            ],
      -            "type": "string"
      -          },
      -          "value": {
      -            "maxLength": 256,
      -            "minLength": 1,
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "type",
      -          "value"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "type": {
      -            "enum": [
      -              "has_attachment",
      -              "list_unsubscribe_exists"
      -            ],
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "type"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "conditions": {
      -            "items": {
      -              "$ref": "#/definitions/__schema0"
      -            },
      -            "maxItems": 10,
      -            "minItems": 1,
      -            "type": "array"
      -          },
      -          "match_mode": {
      -            "enum": [
      -              "all",
      -              "any"
      -            ],
      -            "type": "string"
      -          },
      -          "type": {
      -            "const": "group",
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "type",
      -          "match_mode",
      -          "conditions"
      -        ],
      -        "type": "object"
      -      }
      -    ]
      -  }
      -}
    • changedInput schema / properties / rules / items / properties / actions / items / anyOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "target": {
      -        "anyOf": [
      -          {
      -            "properties": {
      -              "kind": {
      -                "const": "system",
      -                "type": "string"
      -              },
      -              "role": {
      -                "enum": [
      -                  "inbox",
      -                  "archive",
      -                  "junk",
      -                  "trash"
      -                ],
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "kind",
      -              "role"
      -            ],
      -            "type": "object"
      -          },
      -          {
      -            "properties": {
      -              "folder_id": {
      -                "maxLength": 256,
      -                "minLength": 1,
      -                "type": "string"
      -              },
      -              "kind": {
      -                "const": "custom",
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "kind",
      -              "folder_id"
      -            ],
      -            "type": "object"
      -          }
      -        ]
      -      },
      -      "type": {
      -        "const": "move",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "target"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "type": {
      -        "enum": [
      -          "mark_read",
      -          "star"
      -        ],
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "type": {
      -        "const": "send_webhook",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "instructions": {
      -        "maxLength": 2000,
      -        "minLength": 1,
      -        "type": "string"
      -      },
      -      "reply_mode": {
      -        "enum": [
      -          "reply",
      -          "reply_all"
      -        ],
      -        "type": "string"
      -      },
      -      "type": {
      -        "const": "ai_draft_reply",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "instructions",
      -      "reply_mode"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "target": {
      +        "anyOf": [
      +          {
      +            "properties": {
      +              "kind": {
      +                "const": "system",
      +                "type": "string"
      +              },
      +              "role": {
      +                "enum": [
      +                  "inbox",
      +                  "archive",
      +                  "junk",
      +                  "trash"
      +                ],
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "kind",
      +              "role"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "properties": {
      +              "folder_id": {
      +                "maxLength": 256,
      +                "minLength": 1,
      +                "type": "string"
      +              },
      +              "kind": {
      +                "const": "custom",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "kind",
      +              "folder_id"
      +            ],
      +            "type": "object"
      +          }
      +        ]
      +      },
      +      "type": {
      +        "const": "move",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "target"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "type": {
      +        "enum": [
      +          "mark_read",
      +          "star"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "type": {
      +        "const": "send_webhook",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type"
      +    ],
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / rules / items / properties / actions / maxItems
      Previous value: -5New value: +4
    • changedInput schema / properties / rules / items / properties / conditions / items / $ref
      Previous value: -"#/definitions/__schema0"New value: +"#/$defs/__schema0"
    • addedOutput schema / $defs
      Added value: +{
      +  "__schema0": {
      +    "anyOf": [
      +      {
      +        "additionalProperties": false,
      +        "properties": {
      +          "type": {
      +            "enum": [
      +              "from_is",
      +              "from_contains",
      +              "recipient_is",
      +              "plus_tag_is",
      +              "subject_contains"
      +            ],
      +            "type": "string"
      +          },
      +          "value": {
      +            "maxLength": 256,
      +            "minLength": 1,
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type",
      +          "value"
      +        ],
      +        "type": "object"
      +      },
      +      {
      +        "additionalProperties": false,
      +        "properties": {
      +          "type": {
      +            "enum": [
      +              "has_attachment",
      +              "list_unsubscribe_exists"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type"
      +        ],
      +        "type": "object"
      +      },
      +      {
      +        "additionalProperties": false,
      +        "properties": {
      +          "conditions": {
      +            "items": {
      +              "$ref": "#/$defs/__schema0"
      +            },
      +            "maxItems": 10,
      +            "minItems": 1,
      +            "type": "array"
      +          },
      +          "match_mode": {
      +            "enum": [
      +              "all",
      +              "any"
      +            ],
      +            "type": "string"
      +          },
      +          "type": {
      +            "const": "group",
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "type",
      +          "match_mode",
      +          "conditions"
      +        ],
      +        "type": "object"
      +      }
      +    ]
      +  }
      +}
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedOutput schema / definitions
      Removed value: -{
      -  "__schema0": {
      -    "anyOf": [
      -      {
      -        "additionalProperties": false,
      -        "properties": {
      -          "type": {
      -            "enum": [
      -              "from_is",
      -              "from_contains",
      -              "recipient_is",
      -              "plus_tag_is",
      -              "subject_contains"
      -            ],
      -            "type": "string"
      -          },
      -          "value": {
      -            "maxLength": 256,
      -            "minLength": 1,
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "type",
      -          "value"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "additionalProperties": false,
      -        "properties": {
      -          "type": {
      -            "enum": [
      -              "has_attachment",
      -              "list_unsubscribe_exists"
      -            ],
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "type"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "additionalProperties": false,
      -        "properties": {
      -          "conditions": {
      -            "items": {
      -              "$ref": "#/definitions/__schema0"
      -            },
      -            "maxItems": 10,
      -            "minItems": 1,
      -            "type": "array"
      -          },
      -          "match_mode": {
      -            "enum": [
      -              "all",
      -              "any"
      -            ],
      -            "type": "string"
      -          },
      -          "type": {
      -            "const": "group",
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "type",
      -          "match_mode",
      -          "conditions"
      -        ],
      -        "type": "object"
      -      }
      -    ]
      -  }
      -}
    • changedOutput schema / properties / rules / properties / rules / items / properties / actions / items / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "target": {
      -        "anyOf": [
      -          {
      -            "additionalProperties": false,
      -            "properties": {
      -              "kind": {
      -                "const": "system",
      -                "type": "string"
      -              },
      -              "role": {
      -                "enum": [
      -                  "inbox",
      -                  "archive",
      -                  "junk",
      -                  "trash"
      -                ],
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "kind",
      -              "role"
      -            ],
      -            "type": "object"
      -          },
      -          {
      -            "additionalProperties": false,
      -            "properties": {
      -              "folder_id": {
      -                "maxLength": 256,
      -                "minLength": 1,
      -                "type": "string"
      -              },
      -              "kind": {
      -                "const": "custom",
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "kind",
      -              "folder_id"
      -            ],
      -            "type": "object"
      -          }
      -        ]
      -      },
      -      "type": {
      -        "const": "move",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "target"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "type": {
      -        "enum": [
      -          "mark_read",
      -          "star"
      -        ],
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "type": {
      -        "const": "send_webhook",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "instructions": {
      -        "maxLength": 2000,
      -        "minLength": 1,
      -        "type": "string"
      -      },
      -      "reply_mode": {
      -        "enum": [
      -          "reply",
      -          "reply_all"
      -        ],
      -        "type": "string"
      -      },
      -      "type": {
      -        "const": "ai_draft_reply",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "instructions",
      -      "reply_mode"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "target": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "kind": {
      +                "const": "system",
      +                "type": "string"
      +              },
      +              "role": {
      +                "enum": [
      +                  "inbox",
      +                  "archive",
      +                  "junk",
      +                  "trash"
      +                ],
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "kind",
      +              "role"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "additionalProperties": false,
      +            "properties": {
      +              "folder_id": {
      +                "maxLength": 256,
      +                "minLength": 1,
      +                "type": "string"
      +              },
      +              "kind": {
      +                "const": "custom",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "kind",
      +              "folder_id"
      +            ],
      +            "type": "object"
      +          }
      +        ]
      +      },
      +      "type": {
      +        "const": "move",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "target"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "type": {
      +        "enum": [
      +          "mark_read",
      +          "star"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "type": {
      +        "const": "send_webhook",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type"
      +    ],
      +    "type": "object"
      +  }
      +]
    • changedOutput schema / properties / rules / properties / rules / items / properties / actions / maxItems
      Previous value: -5New value: +4
    • changedOutput schema / properties / rules / properties / rules / items / properties / conditions / items / $ref
      Previous value: -"#/definitions/__schema0"New value: +"#/$defs/__schema0"
  2. First observedv0.1.9

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already mark it as destructive and not read-only; the description adds behavioural context by stating 'replace every' and 'preserve any rules that should remain', which clarifies the full replacement nature. No contradiction with annotations.

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?

Two sentences with no superfluous text. The first sentence states the action, the second provides critical operational guidance. Every word earns its place.

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?

For a tool with a complex nested input schema, the description provides essential operational context (fetch-first, replace-all) that compensates for the schema's detail. The presence of an output schema further reduces the need to describe return values.

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

Parameters4/5

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

The schema covers 67% of parameters with descriptions, but the description adds semantic guidance by explaining that the 'rules' parameter should contain the final set of rules and that existing rules should be fetched and preserved. This adds meaning beyond the schema itself.

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 verb 'Replace' and the resource 'every deterministic server-side inbox rule for a mailbox'. It distinguishes itself from sibling tools like 'shipmail_get_mailbox_rules' by indicating a write operation and providing a prerequisite step.

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?

Explicitly instructs the agent to call shipmail_get_mailbox_rules first and preserve any rules that should remain, which serves as a clear when-to-use and how-to-use guide. However, it does not explicitly state alternatives or when not to use it.

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/shipmail-to/shipmail-mcp'

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