Skip to content

docs(ai): refresh MCP Integration page for docs-mcp v0.1.6 and add AI-agent + Docs MCP sections to every UI Kit - #530

Open
ketanyekale wants to merge 4 commits into
mainfrom
docs/mcp-server-page
Open

ketanyekale wants to merge 4 commits into
mainfrom
docs/mcp-server-page

Conversation

@ketanyekale

@ketanyekale ketanyekale commented Sep 23, 2026 •

Copy link
Copy Markdown
Member

Description

Started as a correction to the MCP Integration page for docs-mcp v0.1.6, and grew to cover the gap that fix exposed: the AI-agent guidance only existed on superseded pages, so the deprecated docs had better AI onboarding than the current ones.

1. MCP Integration page — brought in line with docs-mcp v0.1.6 (live on https://mcp.cometchat.com/mcp since 2026-09-22)

  • Transport is Streamable HTTP. The server has no SSE endpoint (GET /mcp is 405, /sse is 404), so the SSE wording and "type": "sse" are removed.
  • Four tools, including list_cometchat_bundles.
  • Claude: leads with the connector directory listing (https://claude.com/connectors/cometchat), keeps the custom connector as the fallback, and uses the current Customize → Connectors menus.
  • Adds Claude Code and Codex steps, and one-click install links for Cursor and VS Code.
  • Windsurf is now Devin Desktop: current config location, and url, which both of its agents accept.
  • Fixes the Source link text (it said github.com/cometchat/cometchat-mcp, which 404s) and replaces the "always in sync" claim.
  • Standardises the server name on cometchat-docs — the name npx @cometchat/skills add already registers — across the CLI commands, all four JSON/TOML blocks, and the name= parameter of all five one-click install links. Following the page no longer mounts a second copy of a server the reader already has.

2. AI-agent + Docs MCP sections on every current UI Kit overview

React v7, Angular v5, Android v6 and Flutter V6 had no AI-agent section at all — the pattern had only ever landed on the v6/v5/v4 pages it replaced. Each of the six now carries an Integrate with AI Coding Agents section and a Recommended: CometChat Docs MCP accordion, written per platform from agent-skills.mdx: correct target version, detection story, iteration menu, and credentials file (.env prefix · environment.ts · Secrets.xcconfig · cometchat-settings.json · pubspec.yaml asset).

Platform Added
React v7 · Angular v5 · Android v6 · Flutter V6 Full section + MCP accordion (+ AI Skills quick-ref row)
React Native v5 · iOS v5 MCP accordion (section already present)
Vue Standalone MCP accordion only — not a skills-supported platform

3. Accuracy fixes found along the way

  • "30+ more agents" → the 11 agents we actually document. Neither agent-skills.mdx nor the cometchat-skills README supports "30+". Corrected in all 16 places so the claim is consistent site-wide, now linking to /agent-skills#supported-agents instead of the repo.
  • "the skill handles it without the MCP" was wrong. Per agent-skills.mdx, the installer wires the MCP up by default for Claude Code, Cursor, Gemini and Codex (--no-mcp opts out). Corrected in all nine accordions.
  • Push notifications added to the React v7, Angular and iOS iteration menus — agent-skills.mdx lists a push skill for all six platforms, so the menus now match.
  • iOS credentials corrected to Secrets.xcconfig (the page said "Secrets.swift or .xcconfig").
  • "Claude" → "Claude Desktop" in the pointer sentence, which sat confusingly next to a Claude Code block.

4. Removes the orphaned Kotlin UI Kit overview

ui-kit/kotlin/overview.mdx is not in docs.json navigation, has no redirect, and documents a v3-era kit superseded by /ui-kit/android/getting-started-kotlin and /ui-kit/android/getting-started-jetpack. Deleted, with a redirect to the Kotlin getting-started guide so the live URL and its three inbound links keep working.

Also repairs sdk/android/3.0/kotlin-overview.mdx, a stub in navigation whose malformed url: frontmatter (url: /docs/ui-kit/kotlin/overview" — unquoted, stray trailing quote, /docs/ prefix) was already sending readers to a 404 on production today:

https://www.cometchat.com/docs/sdk/android/3.0/kotlin-overview
  -> 307 -> https://www.cometchat.com/docs/docs/ui-kit/kotlin/overview"

It now reads url: "/ui-kit/android/getting-started-kotlin", matching the format of the other 58 internal url: values in the repo. That was the last malformed url: frontmatter on the site.

Related Issue(s)

None.

Type of Change

  • Documentation correction/update

Checklist

  • I have read the CONTRIBUTING document
  • My branch name follows the naming convention
  • My changes follow the documentation style guide
  • I have checked for spelling and grammar errors
  • All links in my changes are valid and working (VS Code install links 302 to vscode: by design)
  • My changes are accurately described in this pull request

Additional Information

Verified:

  • Every changed .mdx compiles under @mdx-js/mdx, including the nested code fences inside <Accordion>.
  • Every internal link and heading anchor added by this PR resolves; the one deleted page is covered by a redirect.
  • Live server checks: GET /mcp → 405, GET /sse → 404, initialize reports serverInfo.version 0.1.6. The four tool names match src/tools/*.ts and the ten bundles match bundles/*.md one-for-one.
  • Structural analysis vs. base: 0 unresolved navigation refs, 0 missing redirects, 0 chained 404s, 0 broken internal links.

Not fixed here (pre-existing on main, flagged for a follow-up): dead heading anchors at ui-kit/angular/v4/getting-started.mdx:185,198, ui-kit/react-native/expo-integration.mdx:71,251, ui-kit/react-native/react-native-cli-integration.mdx:67,303, and ui-kit/ios/core-features.mdx:119.

mint broken-links still stops on the existing parse error in sdk/react-native/authentication-overview.mdx:16, which this PR does not touch and #527 fixes; the two checks above stand in for it.

Screenshots (if applicable)

N/A (text only).

- Transport is Streamable HTTP, not SSE. Drop "type": "sse" from the
  Windsurf snippet and the SSE choice from the VS Code steps.
- List all four tools, including list_cometchat_bundles, as the server
  describes them in v0.1.6.
- Claude: lead with the connector directory listing
  (claude.com/connectors/cometchat) and keep the custom connector as the
  fallback, using the current Customize > Connectors menus.
- Add Claude Code and Codex steps, and one-click install links for Cursor
  and VS Code.
- Windsurf is now Devin Desktop: point to its current config file and use
  "url", which both of its agents accept.
- Fix the Source link text (github.com/cometchat/docs-mcp) and replace the
  "always in sync" claim with how the search index refreshes.
- React UI Kit v6 overview: point the Docs MCP accordion at
  https://mcp.cometchat.com/mcp instead of Mintlify's auto-generated
  /docs/mcp server, and drop "type": "sse".

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Sep 23, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
cometchat 🟢 Ready View Preview Sep 23, 2026, 1:30 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

React v7, Angular v5, Android v6 and Flutter V6 had no AI-agent section at
all — the pattern only ever landed on the superseded v6/v5/v4 pages, so the
deprecated docs had better AI onboarding than the current ones. Adds the full
"Integrate with AI Coding Agents" section plus the Docs MCP accordion to those
four, with the correct target version, detection story and credentials file
per platform.

- React Native v5 and iOS v5 already had the section; they get the MCP
  accordion and the AI Skills quick-reference row.
- Vue and Kotlin get the standalone MCP accordion only. agent-skills.mdx
  lists six supported platforms and neither is one, so a Skills section there
  would be a false promise; the Docs MCP does index their pages.
- Standardises the MCP server name on `cometchat-docs` across mcp-server.mdx
  (CLI commands, all four JSON/TOML blocks, and name= in all five one-click
  install URLs) so following the page no longer mounts a second copy of the
  server the Skills installer already registered.
- Corrects "the skill handles it without the MCP": per agent-skills.mdx the
  installer wires the MCP up by default for Claude Code, Cursor, Gemini and
  Codex, with --no-mcp to opt out.
- Replaces the unsupported "30+ more agents" claim on the current overviews
  with the 11 agents that agent-skills.mdx and the cometchat-skills README
  actually list. 14 legacy/integration pages still carry the old claim and
  are left for a separate pass.
- Fixes the "Claude" -> "Claude Desktop" pointer wording.

Verified: all ten files compile under @mdx-js/mdx, and every internal link and
heading anchor in them resolves. `mint broken-links` is still blocked by the
pre-existing parse error at sdk/react-native/authentication-overview.mdx:16,
which #527 fixes.
… overview

Follow-up to the platform rollout, fixing three regressions that commit
introduced plus one long-standing inaccuracy.

- Normalise the "30+ more agents" claim in all 16 places, not just the two
  current overviews touched earlier. Neither agent-skills.mdx nor the
  cometchat-skills README supports "30+"; the half-done state left the iOS
  overview and the iOS getting-started guide disagreeing one click apart.
  All now name the 11 documented agents and link to
  /agent-skills#supported-agents.

- Add the push-notifications bullet to the React v7, Angular and iOS
  iteration menus. agent-skills.mdx:188-193 lists a `push` skill for all six
  platforms, so three pages advertising push and three not was arbitrary.

- Correct the iOS credentials file to `Secrets.xcconfig`, matching
  agent-skills.mdx:146; the page said "Secrets.swift or .xcconfig".

- Delete ui-kit/kotlin/overview.mdx and redirect it to
  /ui-kit/android/getting-started-kotlin. The page is absent from docs.json
  navigation, has no redirect, and documents a v3-era kit superseded by the
  Kotlin and Jetpack getting-started guides. The redirect keeps the live URL
  and its three inbound links working.

Verified: every changed .mdx compiles under @mdx-js/mdx; every internal link
and heading anchor in the PR resolves; the docs.json diff is the single new
redirect, with all 49 U+200E version-label marks intact.
@ketanyekale ketanyekale changed the title docs(mcp-server): update MCP page for docs-mcp v0.1.6 docs(ai): refresh MCP Integration page for docs-mcp v0.1.6 and add AI-agent + Docs MCP sections to every UI Kit Sep 23, 2026
… stub

sdk/android/3.0/kotlin-overview.mdx is a nav entry whose entire content is a
`url:` frontmatter pointer. The value was unquoted, carried a stray trailing
quote and a /docs/ prefix, which sent readers to a 404 on production:

  https://www.cometchat.com/docs/sdk/android/3.0/kotlin-overview
    -> 307 -> https://www.cometchat.com/docs/docs/ui-kit/kotlin/overview"

It now points at /ui-kit/android/getting-started-kotlin, quoted, matching the
other 58 internal `url:` values in the repo. Pointing at the live target
rather than the redirect this PR adds avoids a needless hop. This was the
last malformed `url:` frontmatter on the site.

@raj-dubey1 raj-dubey1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still needed. Main's mcp-server.mdx still describes the transport as HTTP with Server-Sent Events and gives a "type": "sse" Windsurf config. I checked the live server at mcp.cometchat.com/mcp (docs-mcp 0.1.6): it speaks Streamable HTTP only, exposes 4 read-only tools with outputSchema, and has 10 bundles plus the skills overview resource. That matches this PR. The Claude Code, Codex and connector-directory steps, and the per-platform AI-agent sections, are not on main yet. Removing ui-kit/kotlin/overview.mdx is safe: it is not in nav, and the redirect you add covers its two inbound links. The sdk/android/3.0/kotlin-overview.mdx url fix is still needed.

Blocking: the branch conflicts with main and needs a rebase.

  1. docs.json: keep main's new chat-builder redirects and also your /ui-kit/kotlin/overview redirect. The deletion depends on that redirect.
  2. mcp-server.mdx auto-merges but ends up with two list_cometchat_bundles cards under "Four tools", because main added one in 96a51b5. Drop one, and keep main's Lovable section.
  3. #568 also rewrites the bundles section, saying bundles are built from doc pages and adding angular-uikit-quickstart, which conflicts with this PR's "ten curated bundles" wording. The live server matches this PR today. Please agree with that PR's author on which wording lands.

Non-blocking points are inline.

Comment thread mcp-server.mdx

### Claude (Desktop or claude.ai)
<Note>
If you installed [CometChat Agent Skills](/agent-skills), the installer already

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads as if any Agent Skills install already connected the server. npx @cometchat/skills add only writes the cometchat-docs entry for Claude Code, Cursor, Gemini and Codex, and not when --no-mcp is passed. Suggest: "If you installed Agent Skills for Claude Code, Cursor, Gemini or Codex, the installer already added this server as cometchat-docs (unless you passed --no-mcp)."

Comment thread mcp-server.mdx

Every tool returns structured results that match a declared output schema.

### Ten curated implementation bundles

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#568 rewrites this section to say bundles are compiled from current doc pages, and it adds angular-uikit-quickstart. The live 0.1.6 server still returns 10 bundles with last_verified dates, so this text is accurate today. Please coordinate with #568 so the two don't land contradicting each other.

Comment thread ui-kit/react/overview.mdx
{ "mcpServers": { "cometchat-docs": { "url": "https://mcp.cometchat.com/mcp" } } }
```

No authentication required. `npx @cometchat/skills add` wires this up automatically for Claude Code, Cursor, Gemini, and Codex (pass `--no-mcp` to skip it) — add it by hand only for the other agents. For Claude Desktop, VS Code, and Codex, see [MCP Integration](/mcp-server).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codex appears both in the auto-wired list and in "For Claude Desktop, VS Code, and Codex, see MCP Integration". Suggest "For Claude Desktop, VS Code, and other agents, see MCP Integration." The same sentence is on every platform overview.

This branch was successfully deployed

1 active deployment
staging — 6a9ad534 Deployed Sep 23, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants