Frequently Asked Questions (FAQ) about APIWeaver

Q: What is APIWeaver?

A: APIWeaver is a FastMCP (Model Context Protocol) server that dynamically creates MCP servers from web API configurations. It allows you to easily integrate any REST API, GraphQL endpoint, or web service into an MCP-compatible tool that can be used by AI assistants.

Q: What is MCP (Model Context Protocol)?

A: MCP is an open protocol that standardizes how applications provide context to Large Language Models (LLMs). It acts as a bridge, allowing AI models to access and interact with external data sources and tools.

Q: What transport types does APIWeaver support?

A: APIWeaver supports STDIO (Standard Input/Output), SSE (Server-Sent Events), and Streamable HTTP. Streamable HTTP is the recommended transport for modern web deployments.

Q: How do I install APIWeaver?

A: You can install APIWeaver by cloning or downloading the repository, then running pip install -r requirements.txt.

Q: How do I register an API with APIWeaver?

A: Use the register_api tool, providing the API’s name, base URL, description, authentication details, and endpoint definitions in JSON format.

Q: What authentication methods does APIWeaver support?

A: APIWeaver supports Bearer tokens, API keys (in headers or query parameters), Basic Auth, OAuth2, and custom headers.

Q: How do I test the API connection?

A: Use the test_api_connection tool after registering an API to verify connectivity.

Q: Can I use APIWeaver with Claude Desktop?

A: Yes, APIWeaver is designed to work with AI assistants like Claude. Configure Claude to connect to the APIWeaver server using the appropriate transport type and endpoint.

Q: What are the core tools provided by APIWeaver?

A: The core tools include register_api, list_apis, unregister_api, test_api_connection, call_api, and get_api_schema.

Q: What if I encounter a 401 Unauthorized error?

A: Double-check your authentication credentials to ensure they are correct.

Q: What if I encounter a 404 Not Found error?

A: Verify the base URL and endpoint paths in your API configuration.

Q: How do I choose the right transport type?

A: Use Streamable HTTP for modern deployments, STDIO for local tools, and SSE for legacy clients.

Q: Where can I find more information about API configuration format?

A: Refer to the ‘API Configuration Format’ section in the APIWeaver documentation.

Q: How can I contribute to APIWeaver?

A: Feel free to extend APIWeaver with additional features like OAuth2 token refresh, GraphQL support, WebSocket endpoints, response caching, rate limiting, or request retries.