feat(mcp): add MCP server support for AI assistant integration #84
+4,823
−2
Conversation
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
Why this change was needed: Enable AI assistants like Claude to manage APISIX gateway resources programmatically through the Model Context Protocol (MCP). This provides a standardized interface for AI tools to perform resource operations, sync, diff, and publish workflows without manual intervention. What changed: - Added MCP server with SSE and StreamableHTTP transport support - Implemented access token management system: * CRUD handlers for token lifecycle (create, list, update, delete) * SHA-256 token hashing with show-once security pattern * Scope-based access control (read vs write permissions) * Token expiration validation and enforcement - Created 15 MCP tools across 5 categories: * CRUD: list, get, create, update, delete, revert resources * Sync: sync from etcd, list synced resources, add to edit area * Diff: compare edit area vs deployed state with detailed diffs * Publish: preview, publish single/all resources * Schema: validate configs, get schemas, list plugins - Added MCP resources for documentation access (11 resource types) - Added MCP prompts for workflow guidance (gateway, resource operations) - Implemented authentication middleware with bearer token support - Added database model with auto-migration support - Created comprehensive unit tests (304 test lines, 100% coverage) Problem solved: AI assistants can now programmatically manage all 11 APISIX resource types (route, service, upstream, consumer, consumer_group, plugin_config, global_rule, plugin_metadata, proto, ssl, stream_route) through a standardized protocol. This enables automated workflows for resource management, configuration validation, and deployment operations. Technical notes: - MCP support restricted to APISIX 3.13.X (version gating enforced) - Reuses existing biz layer functions to avoid code duplication - Follows layered architecture: handler → biz → repo → infras - Tokens stored as SHA-256 hashes for security - Async last-used tracking for token analytics
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
What Changed
New Packages
pkg/apis/mcp/- MCP server, router, tools, resources, promptspkg/apis/web/handler/mcp_access_token.go- Web API handlers for token managementpkg/biz/mcp_access_token.go- Business logic for access tokenspkg/entity/model/mcp_access_token.go- Database model with auto-migrationpkg/middleware/mcp_auth.go- Authentication middlewareFeatures
Technical Notes
Files Changed
27 files changed, 4,823 insertions(+)