MCP Konnect

🚀 Kong Konnect: Unleashing API Management Potential

Kong Konnect is a powerful API management platform that empowers enterprises to manage and monitor API services. This document provides a detailed guide on how to use the MCP (Model Context Protocol) server of Kong Konnect to extend its functionality.

🚀 Quick Start

📦 Installation

Install Kong Konnect CLI

1. Install the Kong Konnect CLI using npm:

npm install -g kong-konnect-cli

2. Verify the installation:

kong-konnect --version

Start the MCP Server

After installation, start the MCP server:

node build/index.js

⚙️ Configuration

Create a config.json file in the root directory of the project:

{
  "api_key": "your_kong_api_key",
  "region": "us"
}

✨ Features

Available Tools

Analysis Tools

1. List all control planes:

kong-konnect list-control-planes

2. Get service details:

kong-konnect get-service-details --service-id <SERVICE_ID>

Configuration Tools

1. List all services:

kong-konnect list-services

2. Create a new service:

kong-konnect create-service --name "New Service" --endpoint "/api/new"

Control Plane Tools

1. Check the status of a control plane:

kong-konnect check-control-plane-status --plane-id <PLANE_ID>

💻 Usage Examples

Example 1: Analyze API Traffic

# List all control planes
kong-konnect list-control-planes

# Get the list of services on a specific control plane
kong-konnect get-services --plane-id <PLANE_ID>

# Monitor the traffic of a specific service
kong-konnect monitor-service-traffic --service-id <SERVICE_ID>

Example 2: Configuration Management

# Update the configuration of an existing service
kong-konnect update-service-config --service-id <SERVICE_ID> --config '{"timeout": 3000}'

# Delete an unnecessary service
kong-konnect delete-service --service-id <SERVICE_ID>

📚 Documentation

Project Structure

Here is the file structure of the Kong Konnect project:

kong-konnect/
├── parameters.ts        # Define the parameters of the tools
├── prompts.ts           # Documentation for the tools
├── operations/          # Specific implementation of each operation
│   ├── list-control-planes.ts    # List all control planes
│   └── get-service-details.ts     # Get service details
├── tools.ts             # Register and manage tools
└── index.ts             # The main entry file of the project

Development

Add a New Tool

1. Define parameters in parameters.ts.
2. Update the documentation in prompts.ts.
3. Implement the specific operation logic in the operations/ folder.
4. Register the new tool in tools.ts.
5. Finally, handle the execution of the tool in index.ts.

Troubleshooting

Common Issues

• Connection errors: Check if the API key is valid and the network configuration is correct.
• Permission issues: Ensure that the user has the correct permissions to access the required resources.
• Data loss: Verify that the input parameters and IDs are correct.

By following the above steps, you can smoothly use the MCP server of Kong Konnect to manage your API resources. For more assistance, refer to the official documentation or contact the support team.