Add Appa MCP Enhancer integration#1172
Open
zthewriter wants to merge 6 commits intoGitbookIO:mainfrom
Open
Conversation
Document an architecture pattern that combines GitBook integrations with an external MCP backend so teams can augment docs with repo, website, and MCP URL sources. Made-with: Cursor
🦋 Changeset detectedLatest commit: 29eb473 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
commit: |
Adds a full integration that lets GitBook users augment their docs MCP with additional sources (GitHub repos, websites, other MCP endpoints) through Appa's no-code MCP Studio. Implementation: - gitbook-manifest.yaml with account/space configuration - createIntegration with fetch routes for connect, callback, status, webhook - Auto-sync on space_content_updated events - Status ContentKit block showing endpoint, sources, and usage - Appa API client for provision, sync, and status endpoints - Guide doc for the MCP enhancer architecture pattern Made-with: Cursor
- Replace icon/preview with correct Appa mascot assets (512x512 icon, 1600x800 preview) - Switch callback from raw API key in URL params to short-lived authorization code exchange via server-to-server POST, so credentials never appear in browser history or logs - Add HMAC-SHA256 webhook signature verification using APPA_CLIENT_SECRET - Redesign success page with polished card UI, copy-to-clipboard, and direct link to MCP Studio Made-with: Cursor
Replace the integration icon and preview with the latest Appa logo artwork so marketplace branding matches the current product identity.
Include a patch changeset so the new integration package is versioned and prerelease workflows have explicit metadata. Made-with: Cursor
Regenerate bun.lock with Bun 1.3.3 so pull-request workflows that run bun install --frozen-lockfile can install without lockfile mutation. Made-with: Cursor
Author
|
Quick maintainer-facing update after production validation + CI triage: What I pushed to this PR branch
Why checks were failing
Functional notes from MCP Studio backend validation
Happy to iterate further if maintainers want stricter CI behavior on external PRs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
integrations/appa-mcp-enhancer— a full GitBook integration that enhances docs MCP with additional context sources (GitHub repos, websites, other MCP endpoints) through Appa's no-code MCP Studio.What's included
Integration code (
integrations/appa-mcp-enhancer/)gitbook-manifest.yaml— manifest with account-level connect flow, space-level config (endpoint URL, auto-sync toggle), and scopessrc/index.tsx—createIntegration()entry point with:/connectroute that redirects to Appa for account linking/callbackroute that provisions an MCP server via Appa API and stores credentials/statusJSON endpoint for health checks/webhookroute for external content update triggersspace_content_updatedevent handler for automatic re-indexingsrc/appa.ts— Appa API client (provision, sync, status)src/types.ts— typed configuration interfacespackage.json/tsconfig.json— standard integration package setupGuide doc (
docs/integrations/guides/)How it works
Test plan
gitbook checktsc --noEmitspace_content_updatedevent