Skip to main content
Glama

Supovia

by com.supovia.mcp
OverviewDiscussionsAdmin

Read a help-center article

get_document
Read-onlyIdempotent

Use this when someone needs the text of one help-center article, to quote it or answer a customer from it. Returns the article's title, slug, language, published flag and text up to 20000 characters, with the text's format (html, markdown, plain-text). Not for finding articles on a topic.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugNoArticle slug, used only when documentId is omitted
localeNoLanguage code for the slug lookup, e.g. en, it or fr; defaults to en
documentIdNoArticle id; takes precedence over slug

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusYes
documentYesThe article; null when it is missing or belongs to another organization. Organization ids, translator ids, deprecated slugs, embeddings and arbitrary metadata are never returned.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • changedInput schema / properties / documentId / description
      Previous value: -"Document id. Preferred over slug."New value: +"Article id; takes precedence over slug"
    • changedInput schema / properties / locale / description
      Previous value: -"Locale for the slug lookup (e.g. en, it, fr). Defaults to en."New value: +"Language code for the slug lookup, e.g. en, it or fr; defaults to en"
    • changedInput schema / properties / slug / description
      Previous value: -"Document slug. Used only when documentId is not supplied."New value: +"Article slug, used only when documentId is omitted"
    • changedOutput schema / properties / document / anyOf
      Previous value: -[
-  {
-    "additionalProperties": false,
-    "properties": {
-      "content": {
-        "maxLength": 20000,
-        "type": "string"
-      },
-      "contentFormat": {
-        "anyOf": [
-          {
-            "enum": [
-              "html",
-              "markdown",
-              "plain-text"
-            ],
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "contentTruncated": {
-        "type": "boolean"
-      },
-      "creationTime": {
-        "anyOf": [
-          {
-            "maxLength": 32,
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "id": {
-        "pattern": "^[0-9a-f]{24}$",
-        "type": "string"
-      },
-      "lastEditTime": {
-        "anyOf": [
-          {
-            "maxLength": 32,
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "locale": {
-        "anyOf": [
-          {
-            "maxLength": 20,
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "published": {
-        "type": "boolean"
-      },
-      "slug": {
-        "anyOf": [
-          {
-            "maxLength": 300,
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "title": {
-        "anyOf": [
-          {
-            "maxLength": 200,
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "websiteId": {
-        "anyOf": [
-          {
-            "pattern": "^[0-9a-f]{24}$",
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      }
-    },
-    "required": [
-      "id",
-      "title",
-      "slug",
-      "locale",
-      "websiteId",
-      "published",
-      "content",
-      "contentFormat",
-      "contentTruncated",
-      "creationTime",
-      "lastEditTime"
-    ],
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "content": {
+        "maxLength": 20000,
+        "type": "string"
+      },
+      "contentFormat": {
+        "anyOf": [
+          {
+            "enum": [
+              "html",
+              "markdown",
+              "plain-text"
+            ],
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ],
+        "description": "Syntax the content is written in; null for an empty article"
+      },
+      "contentTruncated": {
+        "description": "True when the content was cut at 20000 characters",
+        "type": "boolean"
+      },
+      "creationTime": {
+        "anyOf": [
+          {
+            "maxLength": 32,
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "id": {
+        "pattern": "^[0-9a-f]{24}$",
+        "type": "string"
+      },
+      "lastEditTime": {
+        "anyOf": [
+          {
+            "maxLength": 32,
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "locale": {
+        "anyOf": [
+          {
+            "maxLength": 20,
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "published": {
+        "type": "boolean"
+      },
+      "slug": {
+        "anyOf": [
+          {
+            "maxLength": 300,
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "title": {
+        "anyOf": [
+          {
+            "maxLength": 200,
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "websiteId": {
+        "anyOf": [
+          {
+            "pattern": "^[0-9a-f]{24}$",
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "id",
+      "title",
+      "slug",
+      "locale",
+      "websiteId",
+      "published",
+      "content",
+      "contentFormat",
+      "contentTruncated",
+      "creationTime",
+      "lastEditTime"
+    ],
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
    • addedOutput schema / properties / document / description
      Added value: +"The article; null when it is missing or belongs to another organization. Organization ids, translator ids, deprecated slugs, embeddings and arbitrary metadata are never returned."
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds genuinely useful behavior beyond that: a 20000-character text cap and the returned format variants (html, markdown, plain-text), though some of this is duplicated by the output schema.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences with the trigger front-loaded and the exclusion last. The enumeration of return fields is slightly redundant given the output schema exists, but it costs little.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With a rich output schema, complete parameter descriptions and full annotation coverage, the description supplies exactly the remaining missing piece – when to reach for this tool versus a search – and nothing an agent needs is absent.

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

Parameters3/5

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

Schema description coverage is 100%, so slug, locale and the documentId-over-slug precedence are already documented in the schema. The description adds no parameter-level meaning, so the baseline 3 applies.

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?

States a specific verb ('returns the text') and resource ('one help-center article'), and explicitly separates itself from topic-search behavior with 'Not for finding articles on a topic,' which routes an agent away from search_documents/list_documents without needing their schemas.

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?

Gives a clear triggering condition ('when someone needs the text of one help-center article, to quote it or answer a customer') plus an explicit exclusion. It stops short of naming the alternative tool (search_documents) outright, so the routing is implied rather than spelled out.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Supovia toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources