Skip to main content

Terra Dashboard MCP - A MCP server for managing your Terra Dashboard.

Project description

Terra MCP Server

A Model Context Protocol server that allows LLMs to configure the TerraAPI dashboard.

Available Tools

  • terra_get_integrations
    • Description: Get list of available integrations.
    • Parameters: None
  • terra_get_detailed_integrations
    • Description: Retrieve a detailed list of supported integrations, filtered by the developer's enabled integrations and the requirement for SDK usage.
    • Parameters:
      • sdk (Optional[bool]): If true, allows SDK integrations to be included in the response.
  • get_destinations
  • get_developer_destination_credentials
    • Description: Get developer destination credentials.
    • Parameters:
      • destination (str): The destination to get credentials for.
  • delete_destination
    • Description: Delete a destination.
    • Parameters:
      • destination (str): The destination to delete.
      • dev_id (Optional[str]): Developer ID. If not provided, uses the environment variable.
  • set_destination_state
    • Description: Set destination state (active or inactive).
    • Parameters:
      • destination (str): The destination to update.
      • active (bool): Whether the destination should be active or not.
  • add_developer_destination
    • Description: Add developer destination.
    • Parameters:
      • destination (str): The destination type to add (e.g. 's3', 'sql', 'webhook').
      • scheme (str): The scheme (e.g 's3/postgres/https/mysql').
      • host (str): The host (e.g 'webhook.site', 'eu-west-2', 'localhost').
      • path (Optional[str]): The path (e.g bucket name, database name, webhook path without leading '/').
      • user (Optional[str]): Username for credentials.
      • password (Optional[str]): Password for credentials.
      • port (Optional[int]): Port for the service if needed.
      • query (Optional[str]): Query string if needed.
      • certificate (Optional[str]): Certificate for certain destinations like GCS.
      • complete_destination (bool, default: True): If true, ping the destination before adding.
  • ping_developer_destination
    • Description: Ping a developer destination to check if it's reachable.
    • Parameters:
      • destination (str): The destination type to ping.
      • scheme (str): The scheme (e.g 's3/postgres/https/mysql').
      • host (str): The host (e.g 'webhook.site', 'eu-west-2', 'localhost').
      • path (Optional[str]): The path (e.g bucket name, database name, webhook path).
      • user (Optional[str]): Username for credentials.
      • password (Optional[str]): Password for credentials.
      • port (Optional[int]): Port for the service if needed.
      • query (Optional[str]): Query string if needed.
      • certificate (Optional[str]): Certificate for certain destinations like GCS.
  • set_provider_keys
    • Description: Set provider keys.
    • Parameters:
      • resource (str): The provider resource.
      • client_id (str): The client ID for the provider.
      • client_secret (str): The client secret for the provider.
      • redirect_url (Optional[str]): The redirect URL for the provider.
  • get_provider_keys
    • Description: Get provider keys.
    • Parameters:
      • resource (str): The provider resource.
  • get_developer_providers
    • Description: Get developer providers.
    • Parameters: None
  • add_providers
    • Description: Add providers.
    • Parameters:
      • providers (list[str]): list of providers to add.
  • deactivate_provider
    • Description: Delete provider.
    • Parameters:
      • provider (str): The provider to deactivate.
  • set_provider_state
    • Description: Set provider state (active or inactive).
    • Parameters:
      • provider (str): The provider to update.
      • active (bool): Whether the provider should be active or not.
  • get_providers_by_popularity
    • Description: Get providers ranked by popularity.
    • Parameters: None
  • add_custom_credentials
    • Description: Add custom credentials for a provider.
    • Parameters:
      • provider (str): The provider to add credentials for.
      • client_id (str): The client ID.
      • client_secret (str): The client secret.
      • redirect_url (Optional[str]): The redirect URL.
  • get_custom_credentials
    • Description: Get custom credentials for a provider.
    • Parameters:
      • provider (str): The provider to get credentials for.
  • search_documentation
    • Description: Allows the MCP client to search our docs.
    • Parameters:
      • query (str): Search query.

Installation

[!NOTE] You will need your TERRA_API_KEY and TERRA_DEV_ID which is available from the dashboard

Using uv (recommended)

When using uv no specific installation is needed. We will use uvx to directly run terramcp.

uv Installation

Mac / Linux

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Using PIP

Alternatively you can install terramcp via pip:

pip install terramcp

After installation, you can run it as a script using:

python -m terramcp

Configuration

Configure for Claude.app

Add to your Claude settings:

Using uvx
{
  "mcpServers": {
    "terramcp": {
      "command": "uvx",
      "args": ["terramcp"],
      "env": {
        "TERRA_API_KEY": "your_api_key_here",
        "TERRA_DEV_ID": "your-dev-id-here"
      }
    }
  }
}
Using pip installation
{
  "mcpServers": {
    "terramcp": {
      "command": "python",
      "args": ["-m", "terramcp"],
      "env": {
        "TERRA_API_KEY": "your_api_key_here",
        "TERRA_DEV_ID": "your-dev-id-here"
      }
    }
  }
}

Configure for Zed

Add to your Zed settings.json:

Using uvx
"context_servers": [
  "terramcp": {
    "command": "uvx",
    "args": ["terramcp"],
    "env": {
        "TERRA_API_KEY": "your_api_key_here",
        "TERRA_DEV_ID": "your-dev-id-here"
    }
  }
],
Using pip installation
"context_servers": {
  "terramcp": {
    "command": "python",
    "args": ["-m", "terramcp"],
    "env": {
        "TERRA_API_KEY": "your_api_key_here",
        "TERRA_DEV_ID": "your-dev-id-here"
    }
  }
},

Configure for VS Code

For quick installation, use one of the one-click install buttons below...

Install with UV in VS Code Install with UV in VS Code Insiders

For manual installation, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing Ctrl + Shift + P and typing Preferences: Open User Settings (JSON) .

Optionally, you can add it to a file called .vscode/mcp.json in your workspace. This will allow you to share the configuration with others.

Note that the mcp key is needed when using the mcp.json file.

Using uvx
{
  "mcp": {
    "servers": {
      "terramcp": {
        "command": "uvx",
        "args": ["terramcp"],
        "env": {
            "TERRA_API_KEY": "your_api_key_here",
            "TERRA_DEV_ID": "your-dev-id-here"
        }
      }
    }
  }
}

Debugging

You can use the MCP inspector to debug the server. For uvx installations:

npx @modelcontextprotocol/inspector uvx terramcp

Or if you've installed the package in a specific directory or are developing on it:

cd path/to/servers/src/terramcp
npx @modelcontextprotocol/inspector uv run terramcp

License

terramcp is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.

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

terramcp-0.1.3.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

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

terramcp-0.1.3-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file terramcp-0.1.3.tar.gz.

File metadata

  • Download URL: terramcp-0.1.3.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.3

File hashes

Hashes for terramcp-0.1.3.tar.gz
Algorithm Hash digest
SHA256 540e94e471fa67d6c5c99e1d35ceb76759dc30b88bad478b279472c8ae9880de
MD5 78ad34147f611779d808c0ebafa2a21c
BLAKE2b-256 847bf88ad61a69593891f47ce1a694ca20305e6ad1c84bd34e19e700fe5a9a21

See more details on using hashes here.

File details

Details for the file terramcp-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: terramcp-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.3

File hashes

Hashes for terramcp-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ec6b774533aa0994be2360b455a37aa1898ffb2171d4334e9f2df4039fcd906d
MD5 dd5338fb6c48dde2d6cb33200969e454
BLAKE2b-256 a4f997080628ccc2e44ce8697e7f29bbaf63c7b3c1310772be19a906bd560ec7

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