plugin.json

{
  "$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
  "name": "helpdocs",
  "version": "1.0.0",
  "description": "Connect your HelpDocs knowledge base to ChatGPT to find articles, answer questions from your documentation, and link to the source. Draft and update articles, organize categories, and review knowledge base analytics from a conversation. Available actions depend on the connected user's permissions and account features. Requires a HelpDocs account.",
  "author": {
    "name": "HelpDocs",
    "url": "https://www.helpdocs.io"
  },
  "homepage": "https://www.helpdocs.io",
  "keywords": [
    "knowledge base",
    "documentation",
    "help center"
  ],
  "extensions": {
    "com.openai": {
      "interface": {
        "displayName": "HelpDocs",
        "shortDescription": "Manage your knowledge base",
        "longDescription": "Connect your HelpDocs knowledge base to ChatGPT to find articles, answer questions from your documentation, and link to the source. Draft and update articles, organize categories, and review knowledge base analytics from a conversation. Available actions depend on the connected user's permissions and account features. Requires a HelpDocs account.",
        "developerName": "HelpDocs",
        "category": "Productivity",
        "capabilities": [],
        "websiteURL": "https://www.helpdocs.io",
        "supportURL": "https://support.helpdocs.io",
        "privacyPolicyURL": "https://www.helpdocs.io/privacy",
        "termsOfServiceURL": "https://www.helpdocs.io/terms",
        "defaultPrompt": [
          "Search my knowledge base for articles about refunds and tell me where any two of them contradict each other.",
          "A customer asks how to move their account to a new domain. Answer using only my help articles, and cite the ones you used.",
          "Turn these release notes into a draft HelpDocs article that matches the tone of my existing docs, and leave it unpublished."
        ],
        "brandColor": "#F44599",
        "brandColorDark": "#FFFFFF",
        "composerIcon": "./assets/icon.png",
        "composerIconDark": "./assets/icon-dark.png",
        "logo": "./assets/logo.png",
        "logoDark": "./assets/logo-dark.png"
      },
      "review": {
        "test_cases": {
          "positive": [
            {
              "description": "A support agent asks a question, and the answer must come only from the help center and cite the article it used.",
              "prompt": "Using my HelpDocs knowledge base, how do I reset my password? Cite the article you used.",
              "tools_triggered": "search, fetch",
              "expected_behavior": "Searches for matching articles, reads the best match, and answers from that article only, with its title and public URL. If nothing matches, it says so instead of guessing."
            },
            {
              "description": "A writer turns notes into a new help article that is saved as a draft, not published.",
              "prompt": "Create a draft HelpDocs article called \"Exporting your data\" explaining that users can export a CSV from Settings > Export. Don't publish it.",
              "tools_triggered": "list_categories, create_article",
              "expected_behavior": "Creates a draft article with that title and a short body, and returns its edit link. The status is draft, so readers can't see it."
            },
            {
              "description": "Edit a published article without changing what readers see until someone approves it.",
              "prompt": "Find my article about resetting a password and add a tip at the end: \"If the email doesn't arrive, check your spam folder.\" Save it for review, don't make it live.",
              "tools_triggered": "search, fetch, update_article",
              "expected_behavior": "Finds the article and adds the tip as a working copy. It confirms the change is saved but not live yet, and the published version is unchanged."
            },
            {
              "description": "An admin reviews how the knowledge base is structured and adds a category.",
              "prompt": "List the categories in my knowledge base, then create a new category called \"Billing\".",
              "tools_triggered": "list_categories, create_category",
              "expected_behavior": "Lists the existing categories by name, creates \"Billing\", and confirms it was created along with its ID."
            },
            {
              "description": "A docs owner checks what readers search for and which searches find nothing.",
              "prompt": "What were the top searches in my help center over the last 30 days, and which ones returned no results?",
              "tools_triggered": "get_analytics",
              "expected_behavior": "Summarizes the top searches for the last 30 days and lists the ones that returned no results, using only figures the tool returned."
            }
          ],
          "negative": [
            {
              "description": "The user asks about a third-party product's documentation. They want general knowledge, not their own knowledge base.",
              "prompt": "How do I set up a webhook in Stripe? Check their docs."
            },
            {
              "description": "The user wants documentation-style writing for somewhere other than their help center, like a code README.",
              "prompt": "Write a README for my Python library that explains installation and usage."
            },
            {
              "description": "The user asks about traffic and search terms for their marketing site, which HelpDocs doesn't track.",
              "prompt": "Which Google search keywords brought the most visitors to my company's website last month?"
            }
          ]
        },
        "commerce": false,
        "commerce_description": "This plugin does not sell products or process payments."
      },
      "publication": {
        "release_notes": "First release of HelpDocs for ChatGPT. Connect your HelpDocs knowledge base to search and read your articles, answer questions from your documentation with a link to the source, draft new articles, and edit published ones as working copies that stay unpublished until you release them. You can also organize categories, manage redirects and product updates, and review search and article analytics. What you can do depends on your HelpDocs permissions and plan."
      },
      "apps": "./.app.json"
    }
  }
}