Skip to main content
Glama

Fetch CometChat Documentation Page

fetch_cometchat_doc_page
Read-only

Fetches the full content of a single CometChat documentation page by URL or path. Returns the page content as markdown along with title and section metadata. Path can be passed as a full https://www.cometchat.com/docs URL or as a relative path such as '/sdk/javascript/overview'.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesDocumentation path or full URL. Relative paths like '/sdk/javascript/overview' and full URLs both work.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesCanonical page URL.
titleYesPage title.
contentYesFull page content as markdown (truncated if very large).
sectionYesDocumentation section the page belongs to.
contentLengthYesContent length in bytes after truncation.
redirectedFromNoPath originally requested, present only when that page has moved. url and section describe the page it moved to.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "content": {
      +      "description": "Full page content as markdown (truncated if very large).",
      +      "type": "string"
      +    },
      +    "contentLength": {
      +      "description": "Content length in bytes after truncation.",
      +      "type": "number"
      +    },
      +    "redirectedFrom": {
      +      "description": "Path originally requested, present only when that page has moved. url and section describe the page it moved to.",
      +      "type": "string"
      +    },
      +    "section": {
      +      "description": "Documentation section the page belongs to.",
      +      "type": "string"
      +    },
      +    "title": {
      +      "description": "Page title.",
      +      "type": "string"
      +    },
      +    "url": {
      +      "description": "Canonical page URL.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "title",
      +    "url",
      +    "section",
      +    "content",
      +    "contentLength"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description builds on that by disclosing the return format ('markdown along with title and section metadata') and the flexible path input. It doesn't cover error behavior or rate limits, but for a simple read operation this is solid additional context.

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

Conciseness5/5

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

Two sentences, tightly packed with all essential information: operation, resource, return type, and accepted path forms. No filler or redundant phrases; front-loaded with the core purpose.

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?

For a single-parameter read-only tool with an output schema, the description covers everything an agent needs: the exact input format, the returned content type, and metadata inclusion. There are no hidden requirements or ambiguous behaviors left unexplained.

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%, and the parameter description already explains that both relative paths and full URLs work. The tool description largely repeats this same information with a concrete example, adding no new semantic meaning beyond the schema.

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?

The description uses a specific verb 'Fetches' and a clear resource: 'the full content of a single CometChat documentation page'. It explicitly contrasts with sibling tools by emphasizing 'single page', distinguishing it from search or bundle-list operations. No ambiguity about what the tool does.

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?

The description makes the intended use clear: fetch a known documentation page by URL or path when you need its full markdown content and metadata. It doesn't explicitly name alternatives or exclusion conditions, but the use case is evident from the resource and the sibling context.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.