Kong Konnect

🚀 Kong Konnect MCP Server

Kong Konnect is a powerful platform for managing APIs and microservices. Through the MCP (Management Control Plane) protocol, you can easily interact with Kong Konnect and perform various operations. This document provides a detailed guide on how to use the Kong Konnect MCP Server.

🚀 Quick Start

✨ Features

• Manage APIs and microservices effectively.
• Support various basic and advanced commands for control plane management.
• Analyze API traffic and manage consumer permissions.
• Integrate with Claude Desktop.

📦 Installation

Install the MCP Server

To start using the Kong Konnect MCP Server, follow these installation steps:

1. Clone the Kong Konnect code repository:

   git clone https://github.com/kong/konnect.git
   cd konnect
   

2. Install dependencies and build the project:

   make build
   

3. Start the MCP Server:

   ./bin/konnect-mcp serve --config config.yaml
   

Configure the MCP Server

In the config.yaml file, you can configure the following parameters:

• API Key: Your Kong Konnect API access key.
• Region: The Kong Konnect region you are using (e.g., us, eu).
• Endpoints: The API endpoint URLs of Kong Konnect.

Example configuration:

api_key: your_api_key_here
region: us
endpoints:
  - https://api.konghq.com/v1

💻 Usage Examples

Basic Usage

Here are some basic commands supported by the MCP Server:

• List all control planes:

  konnect-mcp list-control-planes
  

• Get information about a specific control plane:

  konnect-mcp get-control-plane <control_plane_id>
  

• Create a new control plane group:

  konnect-mcp create-group --name my_new_group
  

Advanced Usage

Analyze API Traffic

You can use the MCP Server to analyze the traffic of specific services. For example:

1. List all services:

   konnect-mcp list-services <control_plane_id>
   

2. Query request logs within a specific time period:

   konnect-mcp get-requests --service-id <service_id> --start-time "2023-10-01T00:00:00Z" --end-time "2023-10-02T23:59:59Z"
   

Manage Consumers

You can also manage consumer permissions and policies through the MCP Server. For example:

1. List all consumers:

   konnect-mcp list-consumers <control_plane_id>
   

2. Update a consumer's API access permissions:

   konnect-mcp update-consumer <consumer_id> --add-permission "/my_api/*"
   

📚 Documentation

Integrate with Claude

Install Claude Desktop

1. Download and install Claude Desktop.

2. Open the configuration file:

   • MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: %APPDATA%\Claude\claude_desktop_config.json

3. Add the configuration for the Kong Konnect MCP Server:

   {
     "mcpServers": {
       "kong-konnect": {
         "command": "node",
         "args": [
           "/absolute/path/to/mcp-konnect/build/index.js"
         ],
         "env": {
           "KONNECT_ACCESS_TOKEN": "your_api_key_here",
           "KONNECT_REGION": "us"
         }
       }
     }
   }
   

4. Restart Claude Desktop to apply the configuration.

Frequently Asked Questions

How to get an API Key?

Visit the Kong Konnect console and go to the Settings > API Keys section to generate a new API Key.

How to solve connection issues?

Ensure that your Kong Konnect instance is running properly and the network connection is not blocked. You can also check the log files for more information:

journalctl -u konnect-mcp.service --since "10 minutes ago"

Example Code

Create a Custom Plugin

Here is a simple Node.js plugin example:

const { MCPClient } = require('kong-konnect');

async function main() {
  const client = new MCPClient({
    apiKey: 'your_api_key_here',
    region: 'us'
  });

  // Get all control plane groups
  const groups = await client.listGroups();
  console.log(groups);
}

main().catch(console.error);

📄 Conclusion

Through this document, you should be able to use the Kong Konnect MCP Server smoothly and perform various operations. If you need more help, please refer to the Kong Konnect documentation or contact the support team.