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

> ## Agent Instructions
> PawSQL 是一个产品：Cloud 是公网部署形态，Engine / Optimizer / Auditor / Advisor / Patroller 是同一产品的组件与交付形态，不是彼此独立的产品。 / PawSQL is a single product: Cloud is the public deployment form, while Engine / Optimizer / Auditor / Advisor / Patroller are components and delivery forms of the same product, not separate products.
> 术语以站内术语表为准：SQL 审核对应英文 SQL Review，查询重写对应 Query Rewrite，索引推荐对应 Index Recommendation；英文内容统一用 Review，不用 Audit。 / Use the site glossary for terminology: 审核 is SQL Review, 重写 is Query Rewrite, 索引推荐 is Index Recommendation; English content uses Review, never Audit.
> 引用能力范围或版本支持时以对应页面为准；标注 unknown、或 status 非 published 的内容表示尚未经产品核实，不应作为事实引用。 / Cite capability scope and version support from the corresponding page; content marked unknown, or with a status other than published, is not yet product-verified and must not be cited as fact.

# Installation and Access Overview

> Set up PawSQL Cloud, PawSQL Server, IDE extensions, or PawSQL MCP and verify end-to-end access.

PawSQL can be used through a web console, an IDE extension, an MCP-compatible AI client, or an API integration. Select where the PawSQL service will run first, then configure identity, network access, and client connectivity.

## Choose a setup

| Access method       | PawSQL service deployment   | Local requirement                    | Best suited for                                   |
| ------------------- | --------------------------- | ------------------------------------ | ------------------------------------------------- |
| PawSQL Cloud        | Managed by PawSQL           | Modern browser                       | Evaluation, individuals, and small teams          |
| PawSQL Server       | Private deployment          | Server-side components and browser   | Enterprise governance and controlled environments |
| DBeaver extension   | Connects to Cloud or Server | Compatible DBeaver client            | Pre-execution SQL review and risk confirmation    |
| JetBrains extension | Connects to Cloud or Server | Compatible JetBrains IDE             | SQL work inside DataGrip or a development IDE     |
| VS Code extension   | Connects to Cloud or Server | Visual Studio Code                   | Repository and editor-based SQL work              |
| PawSQL MCP          | Connects to Cloud or Server | MCP runtime and client configuration | Tool-based SQL analysis from AI coding clients    |
| OpenAPI             | Connects to Cloud or Server | HTTP client or integration service   | Automation and platform integration               |

<CardGroup cols={2}>
  <Card title="Use PawSQL Cloud" href="/en/user-guide/installation/pawsql-cloud" icon="cloud" />

  <Card title="Deploy PawSQL Server" href="/en/user-guide/installation/pawsql-server" icon="server" />

  <Card title="Install an IDE extension" href="/en/user-guide/installation/ide-plugins" icon="plug">
    For DBeaver, JetBrains IDEs, or Visual Studio Code.
  </Card>

  <Card title="Configure PawSQL MCP" href="/en/user-guide/dev-tools/mcp" icon="bot" />
</CardGroup>

## Standard access flow

<Steps>
  <Step title="Identify the service">
    Obtain the official PawSQL Cloud URL or the approved endpoint for your PawSQL Server deployment.
  </Step>

  <Step title="Provision identity and permissions">
    Sign in or request an account, then join the correct organization or project.
  </Step>

  <Step title="Verify network access">
    Confirm that browsers, IDEs, MCP clients, or integration workers can reach the service.
  </Step>

  <Step title="Configure the client">
    Install the required extension or runtime and add the endpoint and credentials.
  </Step>

  <Step title="Run an end-to-end check">
    Submit a sanitized test query and confirm authentication, authorization, and analysis services.
  </Step>
</Steps>

## What to prepare

* PawSQL service endpoint and version;
* user account, organization, and project;
* required product permissions;
* supported browser, IDE, or MCP client;
* proxy, DNS, firewall, TLS, and certificate requirements;
* infrastructure, storage, and backup plans for a private deployment;
* DDL or database connectivity for the first workspace.

## Endpoint guidance

* Prefer HTTPS.
* Keep test and production endpoints clearly separated.
* Do not append undocumented API paths.
* Verify certificate trust on every client type.
* When using a gateway, confirm request-size and timeout policies for SQL analysis tasks.

<Warning>
  Keep passwords and access tokens out of source control, screenshots, tickets, and shell history. Use an approved secret store whenever the client supports one.
</Warning>

## Completion criteria

* The service opens at the expected endpoint.
* Authentication succeeds.
* The correct organization and project are visible.
* Menus match the user’s role.
* Client connection tests succeed.
* A sanitized test task can be created and completed.

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" href="/en/user-guide/installation/authentication" />

  <Card title="Verify the installation" href="/en/user-guide/installation/verify-installation" />

  <Card title="Workspaces" href="/en/user-guide/workspaces" />
</CardGroup>