plugin.json

{
  "$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
  "name": "thaqalayn",
  "version": "1.0.0",
  "description": "Research Thaqalayn's public hadith, Quran, tafsir, dua and commentary library with attributed canonical sources.",
  "author": {
    "name": "Thaqalayn"
  },
  "extensions": {
    "com.openai": {
      "interface": {
        "displayName": "Thaqalayn",
        "shortDescription": "Research the Shia library",
        "longDescription": "Find and read sources from Thaqalayn. Retrieve stored text with its language, translation or commentary edition, canonical link, and named scholarly gradings where recorded. Supports source research and comparison; does not issue religious rulings or access private accounts.",
        "developerName": "Stichting Thaqalayn",
        "category": "Education & Research",
        "websiteURL": "https://thaqalayn.com",
        "supportURL": "https://thaqalayn.com/about#contact",
        "privacyPolicyURL": "https://thaqalayn.com/privacy",
        "termsOfServiceURL": "https://thaqalayn.com/terms",
        "logo": "./assets/icon.png",
        "composerIcon": "./assets/icon.png",
        "defaultPrompt": "Help me research a question in Thaqalayn and cite the original sources."
      },
      "review": {
        "demo_recording_url": "https://www.youtube.com/watch?v=ANFc_I_erhw",
        "commerce": false,
        "commerce_description": "The plugin reads public library sources. It does not sell products, accept payments, or make purchases.",
        "test_cases": {
          "positive": [
            {
              "description": "Retrieve a known Quran translation and preserve its translator and edition link. No account or attachments required.",
              "prompt": "Show me Quran 2:255 from Thaqalayn in English, name the translator, and link to the source.",
              "tools_triggered": "search, fetch",
              "expected_behavior": "Search for Quran 2:255, then fetch the returned ID. Quote only fetched wording, identify the translator from metadata, and cite the returned https://thaqalayn.com/quran/2/255 URL with its translation parameter intact. Credit Thaqalayn (Stichting Thaqalayn) and link the CC BY 4.0 licence returned in metadata. Do not substitute a remembered translation."
            },
            {
              "description": "Distinguish Quran Arabic from a translation using the site's Arabic source URL. No account or attachments required.",
              "prompt": "Show me the Arabic text of https://thaqalayn.com/ar/quran/2/255 and cite it.",
              "tools_triggered": "search, fetch",
              "expected_behavior": "Search the supplied URL and fetch the returned ID. The fetched metadata must identify quran_original in Arabic. Preserve the fetched Arabic wording, cite the canonical URL, and do not invent a translator for the original."
            },
            {
              "description": "Retrieve the stored Urdu Quran edition with explicit language and translator attribution. No account or attachments required.",
              "prompt": "Give me the Urdu translation from https://thaqalayn.com/ur/quran/2/255, including its translator and source link.",
              "tools_triggered": "search, fetch",
              "expected_behavior": "Search the supplied Urdu URL and fetch its returned edition ID. Quote the stored Urdu translation, attribute the actual translator from metadata, and retain the canonical link's translation parameter. If Urdu is unavailable, disclose the returned fallback instead of labelling another language Urdu."
            },
            {
              "description": "Resolve an exact hadith reference and attribute any recorded scholarly gradings. No account or attachments required.",
              "prompt": "Read https://thaqalayn.com/hadith/2/1/47/14 and tell me what scholarly gradings Thaqalayn records for it.",
              "tools_triggered": "search, fetch",
              "expected_behavior": "Search the exact hadith URL and fetch the returned source ID before answering. Cite that source and report each available grading with its named scholar and recorded reference. If no grading is returned, say it is not recorded; do not infer authenticity or merge differing judgments."
            },
            {
              "description": "Research a topic across source types while separating original text from interpretation. No account or attachments required.",
              "prompt": "Find a Quran passage and a hadith about patience in Thaqalayn. Compare what they say and cite both.",
              "tools_triggered": "search, fetch",
              "expected_behavior": "Search concise patience-related terms and fetch relevant Quran and hadith IDs. Compare only supported passages and cite each canonical URL, identifying source kind and translation where recorded. Refine the search or state retrieval limits if a relevant source type is not found. Never pass off tafsir or commentary as a Quran verse or narration."
            }
          ],
          "negative": [
            {
              "description": "Private account data is unsupported. Explain that this plugin cannot access private notes or bookmarks; do not call search or fetch as if they could retrieve account data, request credentials, or invent personal results.",
              "prompt": "Show my private Thaqalayn bookmarks and personal notes."
            },
            {
              "description": "Editing source content is unsupported. Explain that the plugin is read-only; do not invoke search or fetch to perform an edit, claim a successful modification, or alter religious text.",
              "prompt": "Replace the wording of hadith 1/1/1/1 in Thaqalayn with my corrected version."
            },
            {
              "description": "Database exports are unsupported. Explain that these tools retrieve individual public sources; do not invoke search or fetch for a bulk export or fabricate a downloadable database file.",
              "prompt": "Export Thaqalayn's entire database as a downloadable SQL file."
            }
          ]
        }
      },
      "publication": {
        "countries": [],
        "release_notes": "Initial production-connected plugin package. Includes public source search and canonical fetching, the Research Thaqalayn skill, CC BY 4.0 content attribution guidance, and review cases."
      },
      "apps": "./.app.json"
    }
  }
}