plugin.json

{
  "$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
  "name": "payperfax",
  "version": "1.0.0",
  "description": "Check the delivery status of a fax sent with PayPerFax, by its tracking ID or tracking link.",
  "author": {
    "name": "PayPerFax",
    "email": "hi@payperfax.com",
    "url": "https://payperfax.com"
  },
  "homepage": "https://payperfax.com/",
  "repository": "https://github.com/payperfax/fax-mcp",
  "keywords": [
    "fax",
    "fax status",
    "fax tracking",
    "delivery status"
  ],
  "extensions": {
    "com.openai": {
      "interface": {
        "displayName": "PayPerFax",
        "shortDescription": "Track the delivery of a fax",
        "longDescription": "Check where a fax sent with PayPerFax is, and whether it arrived.\n\nGive the tracking ID or the tracking link of the fax. PayPerFax returns its status: pending (being prepared or on its way), delivered, failed (not delivered), or expired. For a delivered fax, the answer can include when it was sent and how many pages went through.\n\nThis is the same tracking that the PayPerFax browser extension uses.\n\nLimitations: this plugin only reads the status of an existing fax. It does not send faxes, change them or cancel them. It checks when you ask and does not watch a fax in the background. A fax that you did not send with PayPerFax cannot be tracked.",
        "developerName": "PayPerFax",
        "category": "Productivity",
        "capabilities": [
          "Check fax delivery status"
        ],
        "websiteURL": "https://payperfax.com/",
        "supportURL": "https://payperfax.com/contact-us/",
        "privacyPolicyURL": "https://payperfax.com/policy/privacy/",
        "termsOfServiceURL": "https://payperfax.com/policy/terms-of-service/",
        "defaultPrompt": [
          "Did my PayPerFax fax arrive?",
          "Check the status of my fax from its tracking link.",
          "Why did my fax fail to go through?"
        ],
        "brandColor": "#f78530",
        "logo": "./assets/logo.png",
        "composerIcon": "./assets/logo.png"
      },
      "review": {
        "test_cases": {
          "positive": [
            {
              "description": "Delivered fax, looked up by tracking ID",
              "prompt": "Did my fax arrive? The tracking ID is 00000000-0000-4000-8000-000000000001",
              "tools_triggered": "get_fax_status",
              "expected_behavior": "Reports that the fax was delivered, with the time it was sent and the number of pages sent."
            },
            {
              "description": "Failed fax, looked up by tracking ID",
              "prompt": "What happened to fax 00000000-0000-4000-8000-000000000002?",
              "tools_triggered": "get_fax_status",
              "expected_behavior": "Reports that the fax failed and was not delivered, with the reason the status gives."
            },
            {
              "description": "Fax still in progress",
              "prompt": "Is fax 00000000-0000-4000-8000-000000000003 through yet?",
              "tools_triggered": "get_fax_status",
              "expected_behavior": "Reports that the fax is pending and not yet delivered. Does not check again on its own."
            },
            {
              "description": "Lookup by tracking link instead of bare ID",
              "prompt": "Check this fax for me: https://fax.payperfax.com/api/fax/00000000-0000-4000-8000-000000000001/status",
              "tools_triggered": "get_fax_status",
              "expected_behavior": "Takes the ID from the link and reports the same delivered status as the lookup by ID."
            },
            {
              "description": "Unknown tracking ID",
              "prompt": "Check the status of fax 019f7013-0000-7000-8000-000000000000",
              "tools_triggered": "get_fax_status",
              "expected_behavior": "Reports that no fax has this ID and asks the user to check the tracking ID or link."
            }
          ],
          "negative": [
            {
              "description": "Sending a fax is out of scope",
              "prompt": "Fax this letter to +1 202 555 0143."
            },
            {
              "description": "No tracking ID given",
              "prompt": "Where is my fax?"
            },
            {
              "description": "Continuous monitoring is out of scope",
              "prompt": "Keep checking fax 00000000-0000-4000-8000-000000000003 every minute and tell me when it is delivered."
            }
          ]
        },
        "demo_recording_url": "TODO",
        "commerce": false,
        "commerce_description": "This plugin does not sell anything or process payments. It only reads the delivery status of an existing fax."
      },
      "publication": {
        "release_notes": "Initial release: check the delivery status of a PayPerFax fax by tracking ID or tracking link."
      },
      "apps": "./.app.json"
    }
  }
}