MCP docs
Appear's MCP allows you to seamlessly consume the services Appear has automatically detected, plus any services you have manually imported from your preferred IDE with agent support (ADE).
You and your AI agents can now build with confidence safe in the knowledge that your agents are referencing deterministic, enriched, and real APIs, using the following tools:
Query our docs
List your organisations
List all your branches and environments (versions)
Create a branch or environment (version) within Appear from your IDE
List all services from within Appear
Get service details
We will be expanding this list over time with customer feedback. If you wish to see a specific MCP tool avialable to improve your collaboration with AI agents, please reach out with your request.
Requirements
To connect and make use of Appear's MCP, the following requirements need to be met
An Appear account
Services available in your API Catalog
Agentic IDE, otherwise known as an MCP Client Application (Cursor, Windsurf, RooCode, Cline, Continue, Zed, Claude Desktop)
Overview
Appear is an API Schema Automation Platform, and a core automation is allowing agents to interoperate with the enriched API data within your organisation's account in Appear.
Following the above automation map, we can break down the data flow as follow:
This create a loop to help solve stagnant, incomplete, or missing API documentation from hindering consuming developer's workflow.
We've written an article to explain why enriching your docs with Appear is critical for agent workflows.
Installation
Follow these steps to install the Appear MCP into your chosen agentic IDE (ADE).
Provide MCP access
In your MCP list, click on the 'login' text to trigger the authentication flow.
Your agentic IDE (ADE) may prompt you to open an external website. Proceed and open the URL requested.
Allow access for your agentic IDE to access your email address and basic profile information. This will create the connection between Cursor and your Appear organisation.
Permit 'cursor-retrieval' extension to open the stated URI, by clicking 'Open'
Check Appear MCP is connected
Verify your Appear MCP is connected by viewing your MCP list. It should also list all available tools from the list below.
You should now have your Appear organisation connected to your agentic IDE via Appear's MCP.
If you encounter any issues or are unclear on these steps, please get in touch with us.
Appear MCP tools
The following is a list of the current MCP tools we provide you and your agents for interoperating with your data within your Appear organisation account.
Docs
You can interact with the Docs tool to learn more about using Appear. This tool refers to this doc site and is automatically updated with any changes we make.
Examples:
"How do I filter out NextJS noise?"
"What are the available configurations for the Appear file?"
List orgs
This tool lists the organisations associated to your account. This is required to help you in scoping the context relevant to your current tasks.
List versions
You can list the versions (branches & environments) to assist with you and your agent selecting the appropriate branch or environment relevant to the current task.
Create version
This tool facilitates the ability to create a new environment or branch in your organisation.
List services
A core tool to list all services available within your Appear organisation. This request can be scoped to an organiation and version.
Get service details
This tool will get the full OpenAPI specification of a service, so the agent can provide any level of detail to you and other agents in the toolchain.
Agentic IDE MCP resources
For further information specific to your agentic IDE, please consult their MCP docs.
Troubleshooting
Sometimes the setup or connection process can get fiddly, but we're here to help! We want to ensure you're getting the most out of Appear's MCP to unlock your agentic workflows.
Some basic checks to run through:
Check the MCP is installed and connected
Make sure you've authorised Appear's MCP server by clicking on the 'login' text under the MCP title
Visit your IDE's docs (listed above) for their MCP install process
If these checks don't unblock you then refer to your IDE's MCP debugging controls to obtain logs.
Copy and paste the logs and send to us at @AppearAPI on X or via email at [email protected] and we'll get back to you as soon as possible.
If you have any queries or require support with the above instructions, please get in touch with us.
Last updated
Was this helpful?