> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vistaly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Model Context Protocol (MCP)

> Connect AI assistants like Claude Desktop to your Vistaly workspace

export const Image = ({src, alt, caption}) => <figure>
    <img src={`https://cdn.vistaly.com/kb${src}`} {...alt ? {
  alt
} : {}} />
    {caption && <figcaption class="image-caption">{caption}</figcaption>}
  </figure>;

<Tip>
  The Vistaly MCP server is currently in early development. Features may change or break as we continue to improve the integration.
</Tip>

## Features

* 🔍 **Search** - Find relevant cards using natural language
* 📊 **Metrics tracking** - Update, track, and analyze import KPIs and outcomes
* 💬 **Feedback & interviews** - Send interviews and feedback to your Vistaly workspace
* 📚 **Documentation access** - Browse comprehensive Vistaly documentation, API references, and best practices
* 🔐 **Secure authentication** - Uses your Vistaly API key
* 🏢 **Organization info** - Access workspace and user details

## Quick Start

### 1. Get Your API Key

First, you'll need to create an API key in your Vistaly workspace:

1. Log into your Vistaly workspace at [https://app.vistaly.com](https://app.vistaly.com)
2. Go to `Settings` –> `API Keys`
3. Generate a new API key

<Image src="/documentation/integrations/api/api_keys.png" alt="API Keys" />

*NOTE: After you create an API Key, be sure to store it somewhere secure. You will not be able to access your secret key again, but you can always recreate an API Key at any time.*

### 2. Configure Your AI Assistant

You can connect to Vistaly through various AI assistants:

<Tabs>
  <Tab title="Claude Desktop">
    1. Open Claude Desktop
    2. Go to **Settings**
    3. Click on **Connectors** in the sidebar
    4. Click **Add custom connector**
    5. Enter a name: **Vistaly**
    6. Set the **Remote MCP server URL** to: `https://vst_YOUR_API_KEY@api.vistaly.com/mcp`
       * ⚠️ Replace `vst_YOUR_API_KEY` with your actual Vistaly API key
    7. Click **Add**
  </Tab>

  <Tab title="Claude Code">
    Create an `.mcp.json` file in your project root with the following configuration:

    ```json theme={null}
    {
      "mcpServers": {
        "vistaly": {
          "headers": {
            "Authorization": "Bearer ${VISTALY_API_KEY}",
            "Content-Type": "application/json"
          },
          "type": "http",
          "url": "https://api.vistaly.com/mcp"
        }
      }
    }
    ```

    Then set your API key as an environment variable:

    ```bash theme={null}
    export VISTALY_API_KEY="your-vistaly-api-key"
    ```

    <Note>
      Claude Code will automatically load the `.mcp.json` configuration when you open your project. Make sure the environment variable is set before starting Claude Code.
    </Note>
  </Tab>
</Tabs>

### 3. Restart Your AI Assistant

After saving the configuration, restart your AI assistant (Claude Desktop or Claude Code) to load the new MCP server.

<Note>
  Your Vistaly MCP server will automatically update to the latest version when you open your LLM client. Close and reopen your client if you suspect you're missing new Vistaly MCP capabilities.
</Note>

## Example Prompts for Product Managers

Once connected, you can use these practical prompts to streamline your product management workflow:

### 🔍 **Card Discovery & Research**

> *What open opportunities are we tracking in Vistaly related to user onboarding?*

> *Find all opportunities that have 'Now' or 'Next' statuses and list out all of the solutions we are exploring or building for those opportunities.*

### 📊 **Metrics & Performance Tracking**

> *Update the conversion rate KPI card to 5.8%*

### 💬 **User Research & Feedback**

> *Add the notes from this discovery call as an interview in Vistaly*

> *Take the feedback shared in this sales call and add it to Vistaly*

### 📚 **Learning & Documentation**

> *How should I think about structuring my Vistaly workspace?*

<Tip>
  * Quick access to technical resources
  * Get clear definitions of key concepts
  * Perfect for when you need to understand integration options
  * Great for onboarding new team members or refreshing your knowledge
</Tip>

## Available MCP Tools

The Vistaly MCP server provides access to these core capabilities:

* **Card Search**: Semantic search across your product tree
* **Card Details**: Get comprehensive card information
* **Comments**: Access team discussions and decisions
* **Metrics**: Submit and track KPI data points
* **Feedback**: Capture user insights and research data
* **Interviews**: Log customer research findings
* **Documentation**: Access Vistaly guides and best practices
* **Health Check**: Verify API connectivity

## Troubleshooting

### "API key required" errors

* Double-check your API key is correctly set in the Claude Desktop configuration
* Make sure you've restarted Claude Desktop after updating the config
* Verify your API key is active in your Vistaly settings

### Server connection issues

* Ensure your Claude Desktop configuration file syntax is valid JSON
* Check that the file path is correct for your operating system
* Try restarting Claude Desktop completely
* Verify Node.js 18 or higher is installed on your system

### Authentication errors

* Verify your API key is valid and hasn't expired
* Check that the API key has necessary permissions in Vistaly
* Ensure there are no extra spaces or characters in your API key

## Support

Need help? Check out:

* 🔌 **MCP Documentation**: [modelcontextprotocol.io](https://modelcontextprotocol.io/)
* 🛠 **API Reference**: [Available here](/api-reference/introduction)
* 📧 **Support**: [support@vistaly.com](mailto:support@vistaly.com)

## Related Integrations

Looking for other ways to integrate with Vistaly?

* [**Vistaly API**](/documentation/integrations/vistaly-api) - Direct API integration for custom workflows
* [**Zapier**](/documentation/integrations/zapier) - No-code automation with hundreds of tools
* [**Slack**](/documentation/integrations/slack) - Team notifications and updates