# Sloan / Getting Started Documentation – Python

## Included Files
1. sloan/getting-started/claude.mdx
2. sloan/getting-started/cursor.mdx
3. sloan/getting-started/other-clients.mdx
4. sloan/getting-started/vs-code.mdx
5. sloan/getting-started/windsurf.mdx

## Getting Started

Source: sloan/getting-started/claude.mdx

Getting started guide for Sloan

CTACard,
  CTACards,
  ZoomImg,
  ChipButton,
  Columns,
  Column,
  FeatureCard,
  FeatureGrid,
  BulletPointsCard,
  QnABullets,
  CheckmarkBullets,
  Icons,
} from "@/components";

## Claude Desktop

### Install Claude Desktop
[Install the Claude Desktop application here](https://claude.ai/download). Note, the Pro version appears to work much more stably with MCPs.

### Install Moose and Sloan CLI

```bash filename="Terminal" copy
bash -i <(curl -fsSL https://fiveonefour.com/install.sh) sloan,moose
```

### Configure Sloan MCP

  <Tabs.Tab>
    Create a new project with Claude Desktop MCP preconfigured: 

    ```bash filename="Terminal" copy
    sloan init <project-name> <template-name> --mcp claude-desktop
    ```

    For other options, see [Sloan CLI docs](/sloan/getting-started/sloan-cli).
  </Tabs.Tab>
  <Tabs.Tab>
    ```json filename="~/Library/Application Support/Claude/claude_desktop_config.json" copy
    {
      "mcpServers": {
        "sloan": {
          "args": [
            "@514labs/sloan-mcp@latest",
            "--moose-read-tools",
            "path/to/your/moose/project"
          ],
          "command": "npx",
          "env": {
            "ANTHROPIC_API_KEY": "<your-anthropic-api-key>",
            "MOOSE_PATH": "path/to/your/moose/installation",
            "NODE_PATH": "path/to/your/node/installation",
            "PYTHON_PATH": "path/to/your/python/installation"
          }
        }
      }
    }
    ```
  </Tabs.Tab>

### Adding other toolsets

For more information on available toolsets, see [Sloan MCP toolsets](/sloan/reference/tool-reference). For Claude Desktop, we recommend the following toolsets:

* [Moose Read Tools](../sloan/reference/tool-reference#moose-read-tools): gives you chat access to your Moose project and the data within it (enabled by default)
* [Remote ClickHouse Tools](../sloan/reference/tool-reference#remote-clickhouse) (read only): gives you chat access to your remote ClickHouse data

### Using the MCP

1. Open the Claude Desktop application (note, you often have to reload the application after adding a new MCP)
2. If you are using Moose tools, you will need to run your moose dev server

### Warnings / Peculiarities

* You shouldn't use "write"/generative tools with Claude Desktop.
* Every time you add an MCP or change its configuration, you will need to reload the application.
* If you want to change the Moose Project that the Sloan MCP is referring to, manually edit the MCP.JSON file or run `sloan config focus` and select a new project.

### Common issues / troubleshooting

* The MCP is running, but you aren't able to get your data? Look at the tool call response, it will tell you if your Moose dev server is running. If it is not, run `moose dev` in your Moose project directory.
* The MCP is not running. Check your configuration and then restart the application.

## Reference

---

## Getting Started

Source: sloan/getting-started/cursor.mdx

Getting started guide for Sloan

CTACard,
  CTACards,
  ZoomImg,
  ChipButton,
  Columns,
  Column,
  FeatureCard,
  FeatureGrid,
  BulletPointsCard,
  QnABullets,
  CheckmarkBullets,
  Icons,
} from "@/components";

## Cursor

### Install 
[Install Cursor here](https://www.cursor.com/).

### Install Moose and Sloan CLI

```bash filename="Terminal" copy
bash -i <(curl -fsSL https://fiveonefour.com/install.sh) sloan,moose
```

### Configure Sloan MCP

  <Tabs.Tab>
    Create a new project with Cursor MCP preconfigured: 

    ```bash filename="Terminal" copy
    sloan init <project-name> <template-name> --mcp cursor-project
    ```

    If you want to use this as a global Cursor MCP, use `cursor-global` instead of `cursor-project`.

    For other options, see [Sloan CLI docs](/sloan/getting-started/sloan-cli).
  </Tabs.Tab>
  <Tabs.Tab>
    ```json filename="/path/to/your/project/.cursor/mcp.json" copy
    {
      "mcpServers": {
        "sloan": {
          "args": [
            "@514labs/sloan-mcp@latest",
            "--moose-read-tools",
            "path/to/your/moose/project"
          ],
          "command": "npx",
          "env": {
            "ANTHROPIC_API_KEY": "<your-anthropic-api-key>",
            "MOOSE_PATH": "path/to/your/moose/installation",
            "NODE_PATH": "path/to/your/node/installation",
            "PYTHON_PATH": "path/to/your/python/installation"
          }
        }
      }
    }
    ```
  </Tabs.Tab>

### Adding other toolsets

For more information on available toolsets, see [Sloan MCP toolsets](/sloan/reference/tool-reference). All toolsets are available for Cursor.

### Using the MCP

1. Open Cursor
2. You will see a popup saying that an MCP is detected, and can be enabled. Our experience is that this is not always reliable, and the MCP is more stably launched if you go to `cursor > settings > cursor settings > tools and integrations` and enable the MCP there.
3. If you are using Moose tools, you will need to run your moose dev server with `moose dev`.

### Warnings / Peculiarities

* Every time you add an MCP or change its configuration, you will need to reload the MCP. You can do this by going to `cursor > settings > cursor settings > tools and integrations` and toggling the MCP off and on. If this doesn't work, you can also restart the Cursor application.
* If you have configured the MCP globally, and want to change the Moose Project that the Sloan MCP is referring to, manually edit the MCP.JSON file or run `sloan config focus` and select a new project.

### Common issues / troubleshooting

* The MCP is running, but you aren't able to get your data? Look at the tool call response, it will tell you if your Moose dev server is running. If it is not, run `moose dev` in your Moose project directory.
* The MCP is not running. Check your configuration and then restart the application.  

## Reference

---

## Getting Started

Source: sloan/getting-started/other-clients.mdx

Getting started guide for Sloan

CTACard,
  CTACards,
  ZoomImg,
  ChipButton,
  Columns,
  Column,
  FeatureCard,
  FeatureGrid,
  BulletPointsCard,
  QnABullets,
  CheckmarkBullets,
  Icons,
} from "@/components";

### Other clients

We are working on adding MCP support for other clients. If you are interested in using other clients, please [contact us](mailto:sloan@fiveonefour.com).

To try set up your client with Sloan MCP, use the MCP.JSON file within your client of choice.

### Configure Sloan MCP

**Configuration Object Naming**: Different MCP clients use different naming conventions for the server configuration object:
- **Cursor, Windsurf**: Uses `"mcpServers"`
- **Claude Desktop, VS Code**: Use `"servers"` instead

Make sure to check your specific client's documentation for the correct naming convention.

<Tabs.Tab>
```json filename="MCP configuration" copy
{
  "mcpServers": {
    "sloan": {
      "args": [
        "@514labs/sloan-mcp@latest",
        "--moose-read-tools",
        "path/to/your/moose/project"
      ],
      "command": "npx",
      "env": {
        "ANTHROPIC_API_KEY": "<your-anthropic-api-key>",
        "MOOSE_PATH": "path/to/your/moose/installation",
        "NODE_PATH": "path/to/your/node/installation",
        "PYTHON_PATH": "path/to/your/python/installation"
      }
    }
  }
}
```
</Tabs.Tab>
<Tabs.Tab>
```json filename="MCP configuration" copy
{
  "servers": {
    "sloan": {
      "args": [
        "@514labs/sloan-mcp@latest",
        "--moose-read-tools",
        "path/to/your/moose/project"
      ],
      "command": "npx",
      "env": {
        "ANTHROPIC_API_KEY": "<your-anthropic-api-key>",
        "MOOSE_PATH": "path/to/your/moose/installation",
        "NODE_PATH": "path/to/your/node/installation",
        "PYTHON_PATH": "path/to/your/python/installation"
      }
    }
  }
}
```
</Tabs.Tab>

### Adding other toolsets

For more information on available toolsets, see [Sloan MCP toolsets](/sloan/reference/tool-reference). If the client you are using is a chat client, we recommend the following toolsets:

* [Moose Read Tools](../sloan/reference/tool-reference#moose-read-tools): gives you chat access to your Moose project and the data within it (enabled by default)
* [Remote ClickHouse Tools](../sloan/reference/tool-reference#remote-clickhouse) (read only): gives you chat access to your remote ClickHouse data

If it is an IDE type client, all toolsets are available.

### Using the MCP

1. Open the Claude Desktop application (note, you often have to reload the application after adding a new MCP)
2. If you are using Moose tools, you will need to run your moose dev server

### Common issues / troubleshooting

* The MCP is running, but you aren't able to get your data? Look at the tool call response, it will tell you if your Moose dev server is running. If it is not, run `moose dev` in your Moose project directory.
* The MCP is not running. Check your configuration and then restart the application.

## Reference

---

## Getting Started

Source: sloan/getting-started/vs-code.mdx

Getting started guide for Sloan

CTACard,
  CTACards,
  ZoomImg,
  ChipButton,
  Columns,
  Column,
  FeatureCard,
  FeatureGrid,
  BulletPointsCard,
  QnABullets,
  CheckmarkBullets,
  Icons,
} from "@/components";

## VS Code

- **VS Code**: [Install VS Code here](https://code.visualstudio.com/).
- **GitHub Copilot in VS Code**: [See VS Code docs](https://code.visualstudio.com/docs/copilot/setup)

### Install VS Code and enable MCPs
[Install VS Code here](https://code.visualstudio.com/). 

[Enable MCPs](vscode://settings/chat.mcp.enabled) by toggling on the `chat.mcp.enabled` setting.

### Install Moose and Sloan CLI

```bash filename="Terminal" copy
bash -i <(curl -fsSL https://fiveonefour.com/install.sh) sloan,moose
```

### Configure Sloan MCP

  <Tabs.Tab>
    Create a new project with Claude Desktop MCP preconfigured: 

    ```bash filename="Terminal" copy
    sloan init <project-name> <template-name> --mcp vscode-project
    ```

    If you want to use this as a global VS Code MCP, use `vscode-global` instead of `vscode-project`.

    For other options, see [Sloan CLI docs](/sloan/getting-started/sloan-cli).
  </Tabs.Tab>
  <Tabs.Tab>
    ```json filename="/path/to/your/project/.cursor/settings.json" copy
    {
      "mcp": {
        "input": [],
        "servers": {
          "sloan": {
            "args": [
              "@514labs/sloan-mcp@latest",
              "--moose-read-tools",
              "path/to/your/moose/project"
            ],
            "command": "npx",
            "env": {
              "ANTHROPIC_API_KEY": "<your-anthropic-api-key>",
              "MOOSE_PATH": "path/to/your/moose/installation",
              "NODE_PATH": "path/to/your/node/installation",
              "PYTHON_PATH": "path/to/your/python/installation"
            }
          }
        }
      }
    }
    ```
  </Tabs.Tab>

### Adding other toolsets

For more information on available toolsets, see [Sloan MCP toolsets](/sloan/reference/tool-reference). All toolsets are available for Cursor.

### Using the MCP

[ ] TODO: Add instructions for running the MCP server in VS Code

### Warnings / Peculiarities

**Recommended Configuration Method**: While VS Code has a feature that allows you to use MCPs from other clients (like Claude Desktop), we strongly recommend using either the **Sloan CLI** or the **settings.json file** method shown above instead. These methods provide better reliability and configuration control specifically for VS Code environments.

### Common issues / troubleshooting

* The MCP is running, but you aren't able to get your data? Look at the tool call response, it will tell you if your Moose dev server is running. If it is not, run `moose dev` in your Moose project directory.
* The MCP is not running. Check your configuration and then restart the application.  

## Reference

---

## Getting Started

Source: sloan/getting-started/windsurf.mdx

Getting started guide for Sloan

CTACard,
  CTACards,
  ZoomImg,
  ChipButton,
  Columns,
  Column,
  FeatureCard,
  FeatureGrid,
  BulletPointsCard,
  QnABullets,
  CheckmarkBullets,
  Icons,
} from "@/components";

## Windsurf

### Install Windsurf
[Install Windsurf here](https://windsurf.com/).

### Install Moose and Sloan CLI

```bash filename="Terminal" copy
bash -i <(curl -fsSL https://fiveonefour.com/install.sh) sloan,moose
```

### Configure Sloan MCP

  <Tabs.Tab>
    Create a new project with Windsurf MCP preconfigured: 

    ```bash filename="Terminal" copy
    sloan init <project-name> <template-name> --mcp windsurf-global
    ```

    For other options, see [Sloan CLI docs](/sloan/getting-started/sloan-cli).
  </Tabs.Tab>
  <Tabs.Tab>
    ```json filename="~/.codeium/windsurf/mcp_config.json" copy
    {
      "mcpServers": {
        "sloan": {
          "args": [
            "@514labs/sloan-mcp@latest",
            "--moose-read-tools",
            "path/to/your/moose/project"
          ],
          "command": "npx",
          "env": {
            "ANTHROPIC_API_KEY": "<your-anthropic-api-key>",
            "MOOSE_PATH": "path/to/your/moose/installation",
            "NODE_PATH": "path/to/your/node/installation",
            "PYTHON_PATH": "path/to/your/python/installation"
          }
        }
      }
    }
    ```
  </Tabs.Tab>

### Adding other toolsets

For more information on available toolsets, see [Sloan MCP toolsets](/sloan/reference/tool-reference). All toolsets are available for Windsurf.

### Using the MCP

1. Open Windsurf
2. Run the MCP by going to `windsurf > settings > windsurf settings > cascade > Model Context Protocol (MCP) Servers` and enable the MCP there.
3. If you are using Moose tools, you will need to run your moose dev server with `moose dev`.

### Warnings / Peculiarities

* Every time you add an MCP or change its configuration, you will need to reload the MCP. You can do this by going to `windsurf > settings > windsurf settings > cascade > Model Context Protocol (MCP) Servers` and toggling the MCP off and on or refreshing the server. If this doesn't work, you can also restart the Windsurf application.
* If you have configured the MCP globally, and want to change the Moose Project that the Sloan MCP is referring to, manually edit the MCP.JSON file or run `sloan config focus` and select a new project.

### Common issues / troubleshooting

* The MCP is running, but you aren't able to get your data? Look at the tool call response, it will tell you if your Moose dev server is running. If it is not, run `moose dev` in your Moose project directory.
* The MCP is not running. Check your configuration and then restart the application.

## Reference