Skip to main content

Starlake MCP server.

Project description

starlake-mcp-server

starlake-mcp-server is a Python package that implements a Model Context Protocol (MCP) server, designed to dynamically expose Starlake REST APIs— tagged as "mcp".

Table of Contents

Overview

https://github.com/user-attachments/assets/ed7102bf-2dcc-4d50-9356-597a9558d0a5

Installation

Install the package directly from PyPI using the following command:

uvx starlake-mcp-server

To incorporate starlake-mcp-server into your MCP ecosystem configure it within your mcpServers settings.

{
    "mcpServers": {
      "starlake-mcp-server": {
          "type": "stdio",
          "command": "uvx",
          "args": [
              "starlake-mcp-server"
          ],
          "env" : {
              "DEBUG": "false",
              "OPENAPI_SPEC_URL": "http://localhost:9000/docs/docs.yaml",
              "OPENAPI_SPEC_FORMAT": "yaml",
              "PROJECT_ID": "100",
              "API_KEY": "key as defined in the SL_API_CLI_KEY env var on the Starlake server side",
              "SERVER_URL_OVERRIDE": "http://localhost:9000",
              "API_AUTH_HEADER": "apiKey",
              "API_AUTH_TYPE": "api-key",
              "IGNORE_SSL_SPEC": "false",
              "ENABLE_TOOLS": "true"
          }
      }
    }
}

When running from a local source directory use the followig configuration instead.

{
    "mcpServers": {
      "starlake-mcp-server": {
          "type": "stdio",
          "command": "uv",
          "args": [
              "--directory",
              "/Users/hayssams/git/public/starlake-mcp-server",
              "run",
              "starlake-mcp-server"
          ],
          "env" : {
              "DEBUG": "false",
              "OPENAPI_SPEC_URL": "http://localhost:9000/docs/docs.yaml",
              "OPENAPI_SPEC_FORMAT": "yaml",
              "PROJECT_ID": "100",
              "API_KEY": "key as defined in the SL_API_CLI_KEY env var on the Starlake server side",
              "SERVER_URL_OVERRIDE": "http://localhost:9000",
              "API_AUTH_HEADER": "apiKey",
              "API_AUTH_TYPE": "api-key",
              "IGNORE_SSL_SPEC": "false",
              "ENABLE_TOOLS": "true"
          }
      }
    }
}

Environment Variables

  • DEBUG: (Optional) Enables verbose debug logging when set to "true", "1", or "yes".
  • OPENAPI_SPEC_URL: (Required) The URL to the OpenAPI specification JSON file for your starlake install (located in /docs/docs.yaml file).
  • PROJECT_ID: (Required) Id of your Starlake API project
  • API_KEY: (Required) Authentication token for the API sent as api-key <API_KEY> in the header.
  • API_AUTH_TYPE: (Required) Should be set to apiKey.
  • SERVER_URL_OVERRIDE: (Required) Overrides the base URL of your Starlake API instance
  • IGNORE_SSL_SPEC: (Optional) Set to true to disable SSL certificate verification when fetching the OpenAPI spec.
  • IGNORE_SSL_TOOLS: (Optional) Set to true to disable SSL certificate verification for API requests made by tools.
  • ENABLE_TOOLS: (Optional) Should we enable the tools available in the MCP server. Set to true

License

This project is a fork of the mcp-openapi-proxy available here https://github.com/matthewhand/mcp-openapi-proxy

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

starlake_mcp_server-0.1.0.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

starlake_mcp_server-0.1.0-py3-none-any.whl (26.1 kB view details)

Uploaded Python 3

File details

Details for the file starlake_mcp_server-0.1.0.tar.gz.

File metadata

  • Download URL: starlake_mcp_server-0.1.0.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.4

File hashes

Hashes for starlake_mcp_server-0.1.0.tar.gz
Algorithm Hash digest
SHA256 40aa08c2715a544d3b6ac1a25961e77c1dd1f2dd7fb6ae9bb64d5cbf0f74816c
MD5 2b8a47d56eae777e47397737d897f716
BLAKE2b-256 02f14ba8d36370c4acaa0e721cddae08c3fb4a32740d56d3421b0a5c53e27442

See more details on using hashes here.

File details

Details for the file starlake_mcp_server-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for starlake_mcp_server-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 75c807ea62cd6a92eae7eb954f1b084bd376abc79a4fac58b2ddbf62b9ed88c8
MD5 fb70dcd57938d92c26b8de5aa3ecfba5
BLAKE2b-256 cce43d5656496812bc29314e800d8b841b9252b591d8ce786f6328bdcbcd4e5c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page