create_consumer_group
Create a consumer group
LABSCO SUMMARY
Gateway configuration as a conversation, with a way to test what you just changed.
Most of the surface is CRUD over the Admin API, which is what makes it useful for bulk edits and for reading a configuration you did not write. The tool that changes the loop is the request sender: create or edit a route, then push traffic through the gateway in the same session and see whether it matched.
What it is
A server in front of the APISIX Admin API. It reads and writes the gateway's configuration objects — routes, services, upstreams, SSL certificates, plugins, consumers and secrets — and can fire requests at the gateway itself to see what the configuration actually does.
What you get
- Routes, services and upstreams created, updated and deleted, with load-balancing settings on the upstream
- Any resource fetched by ID or listed by type, and deleted by ID
- Plugin names, schemas and metadata read back, and plugin configs and global rules written
- Consumers, consumer groups and their credentials managed together
- SSL certificates, secrets, stream routes and protobuf definitions created and updated
- A request — or a batch of them — sent through the gateway to check the result
Requirements
A reachable APISIX instance and its Admin API key. Host and Admin API details are supplied as environment settings. Runs under Node from the published package, or from a build of the repository.
Setup effort
One command — npx -y apisix-mcp
USE CASES
01
Standing up a new route end to end
Create the upstream with its load-balancing settings, attach a service, add the route, then send a request through the gateway to confirm it matches.
02
Reading a gateway configuration you inherited
List resources by type and pull individual ones by ID, instead of paging through a dashboard.
03
Turning a plugin on with the right fields
Read the plugin's schema first, then write the plugin config or the global rule that uses it.
04
Giving a client its credentials
Create or update the consumer, attach a credential to it, and group it with the others that share the same rules.
05
Rotating a certificate or a stored secret
Update the SSL certificate or the secret in place rather than re-uploading the whole object.
32 tools
Counted once with only startup setup. Other versions, modes or optional credentials may expose a different list.
create_global_rule
Create a global rule
create_or_update_consumer
Create a consumer, if the consumer already exists, it will be updated
create_or_update_credential
Create or update a credential for a consumer
create_or_update_plugin_metadata
Create or update plugin metadata
create_or_update_proto
Create a proto, if the proto already exists, it will be updated
create_or_update_stream_route
Create a stream route, if the stream route already exists, it will be updated
create_plugin_config
Create a new plugin config
create_route
Create a route
create_secret
Create a secret
create_service
Create a service
create_ssl
Create an SSL certificate
create_upstream
Create an upstream service with load balancing settings
delete_credential
Delete a credential for a consumer
delete_plugin_metadata
Delete plugin metadata
delete_resource
Delete a resource by ID
delete_secret
Delete a secret by ID
get_all_plugin_names
Get all plugin names
get_credential
Get all credentials or a specific credential for a consumer
get_plugin_metadata
Get metadata for a specific plugin
get_plugin_schema
Get all plugins schema or a specific plugin schema by name
get_resource
Get resource details by ID or list all resources
get_secret_by_id
Get a secret by ID
send_request_to_gateway
Send a request or multiple requests to the APISIX gateway
update_consumer_group
Update specific attributes of an existing consumer group
update_global_rule
Update specific attributes of an existing global rule
update_plugin_config
Update a plugin config
update_route
Update specific attributes of an existing route
update_secret
Update specific attributes of an existing secret
update_service
Update specific attributes of an existing service
update_ssl
Update specific attributes of an existing SSL certificate
update_upstream
Update specific attributes of an existing upstream
BEFORE YOU INSTALL
What to know first
Tools you get
32 tools when we connected.
Requires
- npx on PATH
- APISIX_SERVER_HOST in your environment
- APISIX_SERVER_PORT in your environment
- APISIX_ADMIN_API_PORT in your environment
- APISIX_ADMIN_API_PREFIX in your environment
- APISIX_ADMIN_KEY in your environment
CONTEXT COST
Heavy Standing cost
Rated by the size of the 32 tool definitions that ride along on every turn, not by how many there are
INSTALLATION
Connect your client
Add the block to your client, or run the command directly.
Server setup
Configuration file
JSON
{
"mcpServers": {
"apisix-mcp": {
"command": "npx",
"args": [
"-y",
"apisix-mcp"
],
"env": {
"APISIX_SERVER_HOST": "<YOUR_APISIX_SERVER_HOST>",
"APISIX_SERVER_PORT": "<YOUR_APISIX_SERVER_PORT>",
"APISIX_ADMIN_API_PORT": "<YOUR_APISIX_ADMIN_API_PORT>",
"APISIX_ADMIN_API_PREFIX": "<YOUR_APISIX_ADMIN_API_PREFIX>",
"APISIX_ADMIN_KEY": "<YOUR_APISIX_ADMIN_KEY>"
}
}
}
}npx
TERMINAL
npx -y apisix-mcp
