GETTING_STARTED.md

Getting Started with Teradata MCP Server

📍 Navigation: Documentation Home | Server Guide | Getting started | Architecture | Installation | Configuration | Security | Customization | Client Guide

Welcome to the Teradata MCP Server! This guide helps you choose the right starting point based on your needs.

🏗 Setting Up your environment? (15 minutes)

→ Installation Guide

Choose your deployment method:

• CLI Install - System-wide command using uv or pipx (recommended)
• Docker - Build from source for containerized deployments
• pip + venv - Traditional Python virtual environments
• Source build - Development and contributions

---

⚙️ Need to Configure the Server?

→ Configuration Guide

Reference for:

• Environment variables and profiles
• Database connection tuning
• Transport modes (stdio vs HTTP)
• Production optimization

---

🔒 Security Setup?

→ Security Guide

Reference guide for:

• Securing a remote server deployment
• Implementing user authentication
• Implementing data security
• Understanding Audit mechanisms

---

🛠 Want to Customize Tools, Prompts and Resources for your Business context?

→ Customization Guide

We make it very quick and easy to create your own: Create:

• Domain-specific tools and prompts
• Business semantic layers
• Custom cubes and glossaries
• All in YAML-based configurations

---

👥 Connect AI Clients?

→ Client Guide

Supports:

• Claude Desktop, VS Code, Google Gemini
• Web applications and REST APIs
• Custom MCP client integrations

🏗 Understanding the Architecture

→ Architecture Overview

This guide gives you an overview of:

• Component relationships
• Request flow and security
• Deployment patterns
• Integration points

🎬 Prefer Video Learning?

→ Video Library

Watch step-by-step tutorials for:

• Installation and setup
• Client connections
• Custom tool creation
• Troubleshooting common issues

🤔 Still Not Sure Where to Start?

For Different Roles:

Data Analyst/Scientist:

1. Quick Start (Claude) → Client Guide

Software Developer:

1. Quick Start (VS Code) → VS Code Guide

Data Engineer/Admin:

1. Architecture → Installation → Security

Business User:

1. Quick Start (Claude) → Customization

By Use Case:

Chat with your data: Quick Start (Claude)
Development/Coding: Quick Start (VS Code)
Organization Setup: Installation + Security
Application Integration: Installation + Client Guide
Business Customization: Quick Start (Claude) + Customization

🆘 Need Help?

• 🎬 Visual learner? → Video Library
• 🤝 Want to contribute? → Developer Guide
• 💡 Found an issue? → Open a GitHub issue

---

Choose your path above to get started with the Teradata MCP Server!