API Suggestion Server
by nimiusrd
API Suggestion Server is an MCP server that suggests appropriate API endpoints based on OpenAPI specifications. It helps users find the best API endpoints based on their needs and requirements.
Last updated: N/A
What is API Suggestion Server?
API Suggestion Server is an MCP (Model Context Protocol) server designed to suggest suitable API endpoints based on OpenAPI specifications. It facilitates the discovery of relevant APIs for specific purposes by interacting with AI models.
How to use API Suggestion Server?
- Clone the repository and install dependencies using npm or yarn. 2. Configure the server by modifying the
server.config.ts
file to include the URLs or file paths of your OpenAPI specifications. 3. Start the server usingnpm start
. 4. Integrate with an MCP-compatible AI model (e.g., Claude) by sending requests with a 'suggest_api' tool. The server will respond with a list of relevant API endpoints.
Key features of API Suggestion Server
Collects API endpoint information from multiple OpenAPI specifications (YAML or JSON).
Suggests relevant API endpoints based on user's purpose.
Integrates with AI models through the MCP protocol.
Supports both URL and file path for OpenAPI specifications.
Configurable via
server.config.ts
.
Use cases of API Suggestion Server
Assisting developers in discovering relevant APIs for their tasks.
Enabling AI models to dynamically suggest API endpoints to users.
Simplifying the integration of multiple APIs into a single application.
Providing a centralized API discovery service within an organization.
FAQ from API Suggestion Server
What is MCP?
What is MCP?
MCP stands for Model Context Protocol, a protocol for communication between AI models and external tools.
What OpenAPI specifications are supported?
What OpenAPI specifications are supported?
The server supports OpenAPI specifications in YAML (.yaml or .yml) and JSON (.json) formats, either from a URL or a local file path.
How do I add a new OpenAPI specification?
How do I add a new OpenAPI specification?
Add the OpenAPI specification file to the schemas
directory or provide a public URL, then update the server.config.ts
file to include the new service.
What AI models can I use with this server?
What AI models can I use with this server?
You can use any AI model that supports the MCP protocol, such as Claude or GPT-4.
How do I contribute to this project?
How do I contribute to this project?
You can contribute by reporting bugs, suggesting new features, or submitting pull requests through the GitHub issue tracker.