Skip to content

Commit 95f81aa

Browse files
authored
Doc for v1.4 (#177)
* updated main readme * fixed links * update links * updates
1 parent 932eaa6 commit 95f81aa

File tree

3 files changed

+28
-56
lines changed

3 files changed

+28
-56
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Overview
44
The Teradata MCP server provides sets of tools and prompts, grouped as modules for interacting with Teradata databases. Enabling AI agents and users to query, analyze, and manage their data efficiently.
55

6-
6+
![Getting Started](https://raw.githubusercontent.com/Teradata/teradata-mcp-server/main/docs/media/client-server-platform.png)
77

88
## Key features
99

@@ -27,7 +27,7 @@ We are providing groupings of tools and associated helpful prompts to support al
2727
- [Security Tools](https://github.com/Teradata/teradata-mcp-server/blob/main/src/teradata_mcp_server/tools/sec/README.md)
2828

2929
## Quick start with Claude Desktop (no installation)
30-
30+
> Prefer to use other tools? Check out our Quick Starts for [VS Code/Copilot](https://github.com/Teradata/teradata-mcp-server/blob/main/docs/server_guide/QUICK_START_VSCODE.md), [Open WebUI](https://github.com/Teradata/teradata-mcp-server/blob/main/docs/server_guide/QUICK_START_OPEN_WEBUI.md), or dive into [simple code examples](https://github.com/Teradata/teradata-mcp-server/blob/main/examples/README.md#client-applications)!
3131
You can use Claude Desktop to give the Teradata MCP server a quick try, Claude can manage the server in the background using `uv`. No permanent installation needed.
3232

3333
**Pre-requisites**
@@ -53,17 +53,17 @@ Configure the claude_desktop_config.json (Settings>Developer>Edit Config) by add
5353

5454
## Setting up your environment
5555

56-
![Getting Started](https://raw.githubusercontent.com/Teradata/teradata-mcp-server/main/docs/media/MCP-quickstart.png)
56+
Follow this process to install your server, connect it to your Teradata platform and integrated your tools.
5757

5858
**Step 1.** - Identify the running Teradata System, you need username, password and host details. If you do not have a Teradata system to connect to, then leverage [Teradata Clearscape Experience](https://www.teradata.com/getting-started/demos/clearscape-analytics)
5959

6060
**Step 2.** - To install, configure and run the MCP server, refer to the [Getting started guide](https://github.com/Teradata/teradata-mcp-server/blob/main/docs/server_guide/GETTING_STARTED.md), or see below for a quick [CLI installation](#CLI-Installation). You can easily [customize the server with your own tools, prompts and resources](docs/server_guide/CUSTOMIZING.md).
6161

62-
**Step 3.** - There are many client options available, the [Client Guide](https://github.com/Teradata/teradata-mcp-server/blob/main/docs/client_guide/CLIENT_GUIDE.md) explains how to configure and run a sample of different clients.
62+
**Step 3.** - There are many client options available, the [Client Guide](https://github.com/Teradata/teradata-mcp-server/blob/main/docs/README.md#-client-guide) explains how to configure and run a sample of different clients.
6363

6464
<br>
6565

66-
Check out our libraries of [curated examples](https://github.com/Teradata/teradata-mcp-server/blob/main/examples/) or [video guides](https://github.com/Teradata/teradata-mcp-server/blob/main/docs/VIDEO_LIBRARY.md).
66+
Check out our [documentation](https://github.com/Teradata/teradata-mcp-server/blob/main/docs/README.md) and libraries of [curated examples](https://github.com/Teradata/teradata-mcp-server/blob/main/examples/) or [video guides](https://github.com/Teradata/teradata-mcp-server/blob/doc-v1.4/docs/server_guide/VIDEO_LIBRARY.md).
6767

6868
<br>
6969

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ New to Teradata MCP Server? Choose your 5-minute quickstart to rapidly evaluate
1111
| [Claude Desktop](server_guide/QUICK_START.md) | CLI (uv/pipx) | stdio | Exploratory Data Analytics, Platform Administration, general evaluation |
1212
| [VS Code + Copilot](server_guide/QUICK_START_VSCODE.md) | CLI (uv/pipx) | HTTP | Data Engineering, Agentic app development |
1313
| [Open WebUI](server_guide/QUICK_START_OPEN_WEBUI.md) | Docker | REST | Local AI, evaluate new LLMs |
14-
| [Code examples](examples/README.md) | Python | HTTP | Build your own client. Example library using ADK, Bedrock, Langchain... |
14+
| [Code examples](../examples/README.md) | Python | HTTP | Build your own client. Example library using ADK, Bedrock, Langchain... |
1515

1616
**Other Options:**
1717
- **[Getting Started Guide](server_guide/GETTING_STARTED.md)** - Detailed path selection and role-based recommendations

docs/server_guide/GETTING_STARTED.md

Lines changed: 22 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,20 @@ Welcome to the Teradata MCP Server! This guide helps you choose the right starti
88

99
### 🚀 **Just Want to Try It? (5 minutes)**
1010

11-
#### **Option A: Claude Desktop**
12-
**[Quick Start (Claude Desktop)](QUICK_START.md)**
11+
New to Teradata MCP Server? Choose your 5-minute quickstart to rapidly evaluate the server with your favorite tool:
1312

14-
Perfect for:
15-
- First-time users and evaluation
16-
- AI chat and data exploration
17-
- Desktop-based data analysis
18-
19-
#### **Option B: VS Code & GitHub Copilot**
20-
**[Quick Start (VS Code)](QUICK_START_VSCODE.md)**
21-
22-
Perfect for:
23-
- VS Code and GitHub Copilot users
24-
- Development workflows in your IDE
25-
- Code completion with Teradata context
26-
27-
#### **Option C: Open WebUI**
28-
**[Quick Start (Open WebUI)](QUICK_START_OPEN_WEBUI.md)**
29-
30-
Perfect for:
31-
- Self-hosted web interface users
32-
- Team sharing and collaboration
33-
- Integration with various LLM models
13+
| **Client** | **Deployment** | **Communication** | **Best For** |
14+
|------------|----------------|------------------|--------------|
15+
| [Claude Desktop](server_guide/QUICK_START.md) | CLI (uv/pipx) | stdio | Exploratory Data Analytics, Platform Administration, general evaluation |
16+
| [VS Code + Copilot](server_guide/QUICK_START_VSCODE.md) | CLI (uv/pipx) | HTTP | Data Engineering, Agentic app development |
17+
| [Open WebUI](server_guide/QUICK_START_OPEN_WEBUI.md) | Docker | REST | Local AI, evaluate new LLMs |
18+
| [Code examples](../examples/README.md) | Python | HTTP | Build your own client. Example library using ADK, Bedrock, Langchain... |
3419

3520
*All options get you running in 5 minutes with minimal configuration.*
3621

3722
---
3823

39-
### 🏗 **Setting Up for Production? (15 minutes)**
24+
### 🏗 **Setting Up your environment? (15 minutes)**
4025
**[Installation Guide](INSTALLATION.md)**
4126

4227
Choose your deployment method:
@@ -45,73 +30,60 @@ Choose your deployment method:
4530
- **pip + venv** - Traditional Python virtual environments
4631
- **Source build** - Development and contributions
4732

48-
*Compare options and get detailed setup instructions.*
49-
5033
---
5134

5235
### ⚙️ **Need to Configure the Server?**
5336
**[Configuration Guide](CONFIGURATION.md)**
5437

55-
Essential for:
38+
Reference for:
5639
- Environment variables and profiles
5740
- Database connection tuning
5841
- Transport modes (stdio vs HTTP)
5942
- Production optimization
6043

61-
*Master all server configuration options.*
62-
6344
---
6445

65-
### 🔒 **Enterprise Security Setup?**
46+
### 🔒 **Security Setup?**
6647
**[Security Guide](SECURITY.md)**
6748

68-
Required for:
69-
- Team deployments
70-
- User authentication
71-
- Audit compliance
72-
- Production security
73-
74-
*Implement authentication and access control.*
49+
Reference guide for:
50+
- Securing a remote server deployment
51+
- Implementing user authentication
52+
- Implementing data security
53+
- Understanding Audit mechanisms
7554

7655
---
7756

78-
### 🛠 **Want Custom Business Tools?**
57+
### 🛠 **Want to Customize Tools, Prompts and Resources for your Business context?**
7958
**[Customization Guide](CUSTOMIZING.md)**
8059

60+
We make it very quick and easy to create your own:
8161
Create:
8262
- Domain-specific tools and prompts
8363
- Business semantic layers
8464
- Custom cubes and glossaries
85-
- YAML-based configurations
86-
87-
*Add your business logic without coding.*
65+
- All in YAML-based configurations
8866

8967
---
9068

91-
### 👥 **Ready to Connect AI Clients?**
69+
### 👥 **Connect AI Clients?**
9270
**[Client Guide](../client_guide/CLIENT_GUIDE.md)**
9371

9472
Supports:
9573
- Claude Desktop, VS Code, Google Gemini
9674
- Web applications and REST APIs
9775
- Custom MCP client integrations
9876

99-
*Connect your favorite AI tools.*
100-
10177
## 🏗 Understanding the Architecture
10278

103-
**New to MCP or want to understand how it all works?**
104-
10579
**[Architecture Overview](ARCHITECTURE.md)**
10680

107-
Learn about:
81+
This guide gives you an overview of:
10882
- Component relationships
10983
- Request flow and security
11084
- Deployment patterns
11185
- Integration points
11286

113-
*Understand the big picture before diving in.*
114-
11587
## 🎬 Prefer Video Learning?
11688

11789
**[Video Library](VIDEO_LIBRARY.md)**
@@ -140,9 +112,9 @@ Watch step-by-step tutorials for:
140112

141113
### By Use Case:
142114

143-
**Personal AI Chat:** [Quick Start (Claude)](QUICK_START.md)
115+
**Chat with your data:** [Quick Start (Claude)](QUICK_START.md)
144116
**Development/Coding:** [Quick Start (VS Code)](QUICK_START_VSCODE.md)
145-
**Team Setup:** [Installation](INSTALLATION.md) + [Security](SECURITY.md)
117+
**Organization Setup:** [Installation](INSTALLATION.md) + [Security](SECURITY.md)
146118
**Application Integration:** [Installation](INSTALLATION.md) + [Client Guide](../client_guide/CLIENT_GUIDE.md)
147119
**Business Customization:** [Quick Start (Claude)](QUICK_START.md) + [Customization](CUSTOMIZING.md)
148120

0 commit comments

Comments
 (0)