Skip to content

Commit c7909ad

Browse files
committed
docs: add Tool Modules section with links to each module README
1 parent 55c61b7 commit c7909ad

1 file changed

Lines changed: 23 additions & 3 deletions

File tree

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ Add this to `claude_desktop_config.json` (Settings > Developer > Edit Config):
5353

5454
| **Use Case** | **Capabilities** | **Tools** |
5555
|---|---|---|
56-
| **Query & Analyze** | Explore tables, profile data, explain results, visualize patterns—no SQL needed | base, dba, qlty, plot |
57-
| **AI & RAG Pipelines** | Semantic search, retrieval-augmented generation, vector storage | rag, tdvs, fs |
58-
| **Database Admin** | Manage security, monitor capacity, automate backups | dba, sec, bar |
56+
| **Query & Analyze** | Explore tables, profile data, explain results, visualize patterns—no SQL needed | [base](src/teradata_mcp_server/tools/base/README.md), [dba](src/teradata_mcp_server/tools/dba/README.md), [qlty](src/teradata_mcp_server/tools/qlty/README.md), [plot](src/teradata_mcp_server/tools/plot/README.md) |
57+
| **AI & RAG Pipelines** | Semantic search, retrieval-augmented generation, vector storage | [rag](src/teradata_mcp_server/tools/rag/README.md), [tdvs](src/teradata_mcp_server/tools/tdvs/README.md), [fs](src/teradata_mcp_server/tools/fs/README.md) |
58+
| **Database Admin** | Manage security, monitor capacity, automate backups | [dba](src/teradata_mcp_server/tools/dba/README.md), [sec](src/teradata_mcp_server/tools/sec/README.md), [bar](src/teradata_mcp_server/tools/bar/README.md) |
5959
| **Custom Logic** | Define domain tools, metrics, and semantic layers in YAML | Customization (no code required) |
6060

6161
## What's New (Latest Release)
@@ -65,6 +65,26 @@ Add this to `claude_desktop_config.json` (Settings > Developer > Edit Config):
6565
- **Row Limit Protection** — Configurable caps (`DEFAULT_ROW_LIMIT`, `MAX_ROW_LIMIT`) prevent LLM token overflow
6666
- **Enhanced Security** — VX views for fine-grained row-level access control
6767

68+
## Tool Modules
69+
70+
Each tool module has detailed documentation explaining available tools and their capabilities:
71+
72+
| Module | Purpose |
73+
|---|---|
74+
| [base](src/teradata_mcp_server/tools/base/README.md) | Query and navigate Teradata databases |
75+
| [dba](src/teradata_mcp_server/tools/dba/README.md) | Database administration and monitoring |
76+
| [sec](src/teradata_mcp_server/tools/sec/README.md) | Security and permission management |
77+
| [rag](src/teradata_mcp_server/tools/rag/README.md) | Retrieval-augmented generation workflows |
78+
| [qlty](src/teradata_mcp_server/tools/qlty/README.md) | Data quality and exploratory data analysis |
79+
| [tdvs](src/teradata_mcp_server/tools/tdvs/README.md) | Vector store operations and semantic search |
80+
| [fs](src/teradata_mcp_server/tools/fs/README.md) | Feature store and analytic functions |
81+
| [bar](src/teradata_mcp_server/tools/bar/README.md) | Backup and restore operations |
82+
| [plot](src/teradata_mcp_server/tools/plot/README.md) | Data visualization and charting |
83+
| [chat](src/teradata_mcp_server/tools/chat/README.md) | Chat completion and conversational AI |
84+
| [graph](src/teradata_mcp_server/tools/graph/README.md) | Dependency and lineage analysis |
85+
| [sql_opt](src/teradata_mcp_server/tools/sql_opt/README.md) | SQL optimization and analysis |
86+
| [tmpl](src/teradata_mcp_server/tools/tmpl/README.md) | Template tools |
87+
6888
## Extend & Deploy
6989

7090
**Add Custom Logic**

0 commit comments

Comments
 (0)