Skip to content

docs: add Claude connector icon guidance - #792

Open
puneetdixit200 wants to merge 6 commits into
alpic-ai:mainfrom
puneetdixit200:codex/claude-connector-icon-docs
Open

docs: add Claude connector icon guidance#792
puneetdixit200 wants to merge 6 commits into
alpic-ai:mainfrom
puneetdixit200:codex/claude-connector-icon-docs

Conversation

@puneetdixit200

@puneetdixit200 puneetdixit200 commented May 20, 2026

Copy link
Copy Markdown

Closes #524.

Summary

  • Documents how to advertise a Claude/custom connector icon through McpServer implementation metadata.
  • Shows the icons fields supported by the MCP SDK: src, mimeType, and sizes.
  • Notes that remote clients need reachable HTTPS or self-contained data: icon sources and that host display support can vary.

Verification

  • pnpm install --frozen-lockfile
  • pnpm test:format
  • pnpm build
  • pnpm --filter @skybridge/docs lint

AI assistance was used to prepare this change. I checked the SDK Implementation type before adding the example and verified the docs/build commands above.

Greptile Summary

This PR documents the icons and title fields on the McpServer constructor's serverInfo argument, explaining how developers can advertise a Connector icon through MCP implementation metadata.

  • Extends the constructor signature block and parameters table with title, and icons (including src, mimeType, sizes, and theme sub-fields), all of which exist in the underlying MCP SDK Implementation type and the MCP 2025-11-25 specification.
  • Adds a new "Implementation metadata" subsection with a runnable TypeScript example and prose guidance on using HTTPS URLs vs. data: URIs for remote reachability.

Confidence Score: 5/5

Documentation-only change that accurately reflects the MCP SDK — safe to merge.

The added fields (title, icons, theme, mimeType, sizes) all exist in the MCP 2025-11-25 specification and in the Implementation type accepted by the McpServer constructor. The example code is syntactically correct and the prose guidance about HTTPS vs. data: URIs is accurate.

No files require special attention.

Reviews (6): Last reviewed commit: "Merge branch 'main' into work/claude-co..." | Re-trigger Greptile

@puneetdixit200
puneetdixit200 marked this pull request as ready for review May 20, 2026 07:01
Comment thread docs/quickstart/test-your-app.mdx Outdated

@harijoe harijoe left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Hi @puneetdixit200, thanks for your contribution!

Could you integrate this new doc to docs/api-reference/mcp-server.mdx instead? It makes more sense to improve the MCP server reference than to add a section to docs/quickstart/test-your-app.mdx.

Also, since it’s your first time contributing to the Skybridge repository, would you mind introducing yourself on our Discord? We’d love to get to know our contributors.

@puneetdixit200

Copy link
Copy Markdown
Author

Moved this into docs/api-reference/mcp-server.mdx in af487d9 and kept the example aligned with the SDK Implementation metadata fields. The docs/build checks listed in the PR body passed after the move.

@puneetdixit200

Copy link
Copy Markdown
Author

The current head addresses the requested placement change: the connector icon guidance now lives in docs/api-reference/mcp-server.mdx, and the quickstart page is no longer touched. REST check-run/status sampling shows no bad visible checks on 7edddd59.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation on how to customize Connector Image on Claude

2 participants