Steampipe MCP

🚀 Steampipe MCP Server Chinese Documentation

This project provides a Chinese documentation for the Steampipe MCP server, offering installation, configuration, and contribution guidance.

🚀 Quick Start

📦 Installation and Configuration

Clone the Repository and Setup

1. Clone the repository and navigate to the directory:

git clone https://github.com/turbot/steampipe-mcp.git
cd steampipe-mcp

2. Install dependencies:

npm install

3. Build the project:

npm run build

Testing

To test the local development version on an MCP-supported AI tool, update your MCP configuration to use the local dist/index.js file instead of the npm package. For example:

{
  "mcpServers": {
    "steampipe": {
      "command": "node",
      "args": [
        "/absolute/path/to/steampipe-mcp/dist/index.js",
        "postgresql://steampipe@localhost:9193/steampipe"
      ]
    }
  }
}

Alternatively, use the MCP Inspector to validate the server implementation:

npx @modelcontextprotocol/inspector dist/index.js

Environment Variables

The following environment variables can be used to configure the MCP server:

• STEAMPIPE_MCP_LOG_LEVEL: Controls the verbosity of server logging (default is info).
• STEAMPIPE_MCP_WORKSPACE_DATABASE: Overrides the default Steampipe connection string (default is postgresql://steampipe@localhost:9193/steampipe).

📄 License

This repository is released under the Apache 2.0 License. Please refer to our code of conduct. We're excited to collaborate with you!

Steampipe is an open-source software product produced by Turbot HQ, Inc and distributed under proprietary terms. Other parties can distribute the software on their own, but they cannot use any Turbot trademarks or cloud services. You can learn more in our Open Source FAQ.

👥 How to Contribute

Join the Slack #steampipe channel →

Not sure where to start? Feel free to pick an issue with the help wanted label:

• Steampipe
• Steampipe MCP