Preview: SendMock has no stable release yet. These docs follow develop.

MCP reference

Projects tools

sendmock_project_create

Add a project that apps can send traffic to by its key.

Toolset core.

    InputTypeDescription
    keyrequiredstring
    What apps send as the SMTP username, the X-SendMock-Project header or the /projects/<key>/ URL prefix. It never changes.Example: shop
    namerequiredstring
    A name for the project, shown in the UI.Example: Shop

    Example call

    {
      "name": "sendmock_project_create",
      "arguments": {
        "key": "shop",
        "name": "Shop"
      }
    }

    Result: Project

    API
    POST/api/v1/projects
    CLI
    sendmock projects create
    In the app
    Settings > Projects > New project

    sendmock_project_delete

    Delete a project with its emails, SMS and verifications.

    Toolset core.

    • Destructive
    • Idempotent
    InputTypeDescription
    project_keyrequiredstring
    The project's key, from the list of projects.Example: shop

    Example call

    {
      "name": "sendmock_project_delete",
      "arguments": {
        "project_key": "shop"
      }
    }

    Result: nothing

    API
    DELETE/api/v1/projects/{projectKey}
    CLI
    sendmock projects delete <projectKey>
    In the app
    Settings > Projects > Delete

    sendmock_project_list

    Every project, default first, with the traffic each holds.

    Toolset core.

    • Read only

    No inputs.

    Example call

    {
      "name": "sendmock_project_list",
      "arguments": {}
    }

    Result: Project[]

    API
    GET/api/v1/projects
    CLI
    sendmock projects list
    In the app
    Settings > Projects

    sendmock_project_update

    Rename a project; its key stays the same.

    Toolset core.

    • Idempotent
    InputTypeDescription
    project_keyrequiredstring
    The project's key, from the list of projects.Example: shop
    namerequiredstring
    A name for the project, shown in the UI.Example: Shop

    Example call

    {
      "name": "sendmock_project_update",
      "arguments": {
        "project_key": "shop",
        "name": "Shop"
      }
    }

    Result: Project

    API
    PATCH/api/v1/projects/{projectKey}
    CLI
    sendmock projects update <projectKey>
    In the app
    Settings > Projects > Rename