Visitar URL original
List a vendor-official adapter | Chat SDK

List a vendor-official adapter

A vendor-official adapter is built and maintained by the company behind the platform or by the primary maintainer of that platform's API. You implement the same Adapter interface as a community adapter. After Vercel accepts your listing, your adapter appears in:

Browse current listings on the Adapters page.

Compare adapter tiers

OfficialVendor-officialCommunity
MaintainerVercelPlatform vendorThird-party developers
npm package@chat-adapter/*Your org scope or unscopedYour org scope or unscoped
Docs listing/adapters/official/…/adapters/vendor-official/…/adapters/community/…
eve.dev/integrationsYesYesNo
@chat-adapter/catalog setup metadataYesYesNo
create-chat-sdkYesYesNo

All three tiers share the same interface. Developers install and register your adapter the same way they use any other adapter. Vendor-official adds stronger discoverability and a higher maintenance bar.

The @chat-adapter/ npm scope is reserved for Vercel-maintained official adapters. Publish under your own org scope or as an unscoped package.

Check qualifications

Before you open a listing PR, confirm that you can meet all of these:

  • You will continue to maintain the adapter
  • The repo lives in an official vendor-owned GitHub organization
  • Your primary product docs cover the adapter
  • You have announced the adapter in a blog post, changelog, or on social media
  • The adapter does not depend on platform APIs that are in private or closed beta
  • The adapter accepts credentials as resolver functions, not only static strings

Support non-static credentials

Credential fields in your adapter config must accept a function alongside a plain string, and the adapter must resolve it on each outbound API call rather than caching the result:

accessToken: string | (() => string | Promise<string>);

This lets developers supply rotating, short-lived tokens from tools like Vercel Connect instead of long-lived secrets. The official adapters that work with Vercel Connect follow this pattern; see the outbound fields in the Vercel Connect adapter table for examples.

If you don't represent the platform vendor, list as community instead.

Review listing terms

Meeting the qualifications does not guarantee acceptance. Vercel reviews each request and may decline a listing for any reason.

If Vercel lists your adapter, you own ongoing support:

  • Keep the adapter compatible with current Chat SDK APIs and your platform's APIs
  • Address bug reports promptly
  • Support developers who use your adapter

Vercel may remove a vendor-official adapter from the docs, catalog, eve integrations, and create-chat-sdk at any time, without notice. Removal can follow lack of maintenance, security or support risk, or failure to meet the tier bar.

Build and publish your package

Ship a published npm package before you ask for a listing. Follow the same guides as community adapters:

  1. Build an adapter
  2. Test it
  3. Document it
  4. Publish it

Your listing PR must point at that published package and a GitHub README pinned to a commit or tag.

Submit a listing PR

Open a pull request against vercel/chat. Copy an existing page from apps/docs/content/adapters/vendor-official/ and replace the details with yours. Choose a short kebab-case slug that is not already taken.

Include all of the following in the PR:

  1. Docs page. Add an MDX page under apps/docs/content/adapters/vendor-official/ and register the slug in that folder's meta.json. Mark the page as vendor-official, set your company as the author, render the feature matrix with <FeatureSupport />, and add install and quick-start examples that match your published package and README.
  2. Catalog entry. Add packages/catalog/src/adapters/vendor-official/your-slug.ts and register it in ADAPTERS in packages/catalog/src/adapters/index.ts. The entry drives the Adapters listing, the feature matrix on your docs page, and setup UIs that read @chat-adapter/catalog without importing your package. Copy a similar vendor-official entry and fill in the package name, author, factory export, peer dependencies, environment variables, and features from your docs. Point readme at a pinned commit or tag, not a branch. See Pin your README to a commit or tag.
  3. CLI scaffold. Add a matching entry in packages/create-chat-sdk/src/catalog/scaffold-spec.ts so create-chat-sdk can generate a bot that uses your adapter. Match the factory call shape of a similar adapter. After merge, developers can pass --adapter your_slug or browse vendor-official adapters with --vendor.
  4. Test allowlists. Update the lists in packages/integration-tests so CI recognizes the new docs page and package imports.
  5. Changeset. Add a changeset that bumps @chat-adapter/catalog and create-chat-sdk (patch), with one line describing the addition.

Prepare for review

Reviewers check that:

  • You meet the qualifications above
  • Install snippets, factory exports, and env vars match the published package and README
  • The README link is pinned to a commit or tag
  • Catalog peer dependencies match what the docs tell people to install
  • Credential fields accept function-form values and are resolved per call
  • The catalog entry matches the docs page, including the package name, author, and capabilities

Keep the listing current

After merge, your adapter appears under Vendor Official on the Adapters page, in the static catalog, on eve.dev/integrations, and in create-chat-sdk when it fits the webhook-only scaffold.

When you change env vars, peer dependencies, or the factory API, open a follow-up PR that updates the docs page, catalog entry, and pinned README ref together.

Read more