MCP

by mconflitti-pbc

API/Management & Tools Connect API Swagger Client-Server OpenAPI

MCP is a simple example demonstrating a client and server interaction using the Connect API. It includes examples of Swagger integration for API exploration and interaction.

View on GitHub

Last updated: N/A

What is MCP?

MCP is a basic client-server example that utilizes the Connect API and integrates with Swagger for API documentation and interaction. It showcases how to register Swagger tools with Chatlas for conversational API interaction.

How to use MCP?

To use MCP, first run the server with your Connect API key and Swagger file. Then, run the client. You can modify the client's chat questions in the app.py file. The README also provides instructions for running a local OpenAPI-compatible server and a Shiny application for interactive API exploration.

Key features of MCP

Client-server communication
Connect API integration
Swagger documentation and tooling
Chatlas integration for conversational API access
Shiny application for interactive demo

Use cases of MCP

Demonstrating basic API client-server interaction
Integrating Swagger for API documentation
Enabling conversational API access with Chatlas
Building interactive API demos with Shiny
Exploring and testing APIs

FAQ from MCP

What is the purpose of the MCP server?

The MCP server serves as a simple example to demonstrate client-server communication using the Connect API.

How do I run the MCP server?

You can run the MCP server using the command CONNECT_API_KEY="<your key>" SWAGGER_FILE="swagger.yaml" make server.

What is Swagger used for in this project?

Swagger is used for API documentation and tooling, allowing you to explore and interact with the API.

How does Chatlas integrate with MCP?

Chatlas is used to register Swagger tools, enabling conversational interaction with the API.

What is the Shiny application used for?

The Shiny application provides an interactive demo for exploring and testing the API.