Allow parameters definition in prompt declarations (#130)

* Allowed parameters definition for prompts declared in *_objects.yml
* moved to build management hatchling
* include tools/*/*_objects.yml files in wheel

Author: remi-td

.gitignore

@@ -8,7 +8,6 @@ working/
 *.egg-info/
 **/.ipynb_checkpoints/
 env
-test_results/
 custom*_objects.yaml
 CLAUDE.md
 var/

Dockerfile

@@ -6,7 +6,10 @@ WORKDIR /app
 ARG ENABLE_FS_MODULE=false
 ARG ENABLE_EVS_MODULE=false
 
-COPY pyproject.toml uv.lock* /app/
+# Copy essential files for dependency installation
+COPY pyproject.toml uv.lock* README.md /app/
+
+# Install system dependencies and Python dependencies
 RUN apt-get update && \
     apt-get install -y --no-install-recommends build-essential gcc && \
     pip install --upgrade pip && \
@@ -15,17 +18,19 @@ RUN apt-get update && \
     UV_EXTRAS="" && \
     if [ "$ENABLE_FS_MODULE" = "true" ]; then UV_EXTRAS="$UV_EXTRAS --extra fs"; fi && \
     if [ "$ENABLE_EVS_MODULE" = "true" ]; then UV_EXTRAS="$UV_EXTRAS --extra evs"; fi && \
-    uv sync $UV_EXTRAS && \
-    uv build && \
+    uv sync $UV_EXTRAS
+
+# Copy source code before building
+COPY ./src /app/src
+
+# Build and install the package
+RUN uv build && \
     pip install . && \
     apt-get purge -y build-essential gcc && \
     rm -rf /var/lib/apt/lists/*
 
-# Copy everything *except* src (excluded via .dockerignore)
+# Copy everything else
 COPY . /app
-
-# Copy src with conditional module directories
-COPY ./src /app/src
 # Remove optional module directories if not enabled
 RUN if [ "$ENABLE_FS_MODULE" != "true" ]; then rm -rf /app/src/teradata_mcp_server/tools/fs; fi && \
     if [ "$ENABLE_EVS_MODULE" != "true" ]; then rm -rf /app/src/teradata_mcp_server/tools/evs; fi

custom_objects.yaml custom_objects.ymlcustom_objects.yaml renamed to custom_objects.yml

@@ -0,0 +1,68 @@
+# Custom tool definitions here
+sales_top_customers:
+  type: tool
+  description: "Get the top 20 customers by lifetime value."
+  sql: |
+    sel top 20 * from dim_customers order by customer_lifetime_value desc;
+
+sales_customer_profile:
+  type: tool
+  description: "Get customer profile and metrics."
+  sql: |
+    sel dim_customers.*, customer_nk as customer_email from dim_customers 
+    join key_customer
+    on dim_customers.customer_key = key_customer.customer_key
+    where dim_customers.customer_key = :customer_key;
+  parameters:
+    customer_key:
+      description: "The key (integer) for the customer to lookup."
+
+sales_cube:
+  type: cube
+  description: "Get the key sales metrics: USD amount and number of orders."
+  sql: |
+    sel customer_key, extract(year from order_date) sales_year, extract(month from order_date) sales_month, gift_card_amount_usd, amount amount_usd
+    from fct_orders o
+  measures:
+    gift_amount_usd:
+      description: "Total gift card amount used for the order in USD"
+      expression: "SUM(gift_card_amount_usd)"
+    total_amount_usd:
+      description: "Total order amount in USD"
+      expression: "SUM(amount_usd)"
+    order_count:
+      description: "Total number of orders"
+      expression: "COUNT(1)"
+  dimensions:
+    customer_key:
+      description: "Key for the customer"
+      expression: "customer_key"
+    sales_year:
+      description: "Year of the sale"
+      expression: "sales_year"
+    sales_month:
+      description: "Month of the sale"
+      expression: "sales_month"
+
+sales_prompt:
+  type: prompt
+  description: "my prompt description"
+  prompt: |
+    You are a data analyst working for a sales team.
+    Your task is to analyze the sales data using the tools you have and provide insights.
+    All your answers must be based on the data you retrieve using the tools, and you must be ready to provide data for your answers.
+
+sales_glossary:
+  type: glossary
+  customer:
+    definition: "A person or organization that purchases goods or services from our business."
+    synonyms:
+      - Clients
+
+  sales:
+    definition: "The key metrics related to completed orders: USD amount and number of orders."
+    synonyms:
+      - revenue
+      - sales figures
+    tools:
+      - sales_cube

custom_sales_objects.yml

@@ -19,7 +19,7 @@ A semantic layer in this context is a collection of custom tools, prompts, cubes
 - **Profiles:** Named sets of tools, prompts, and resources that enable domain-specific server instantiations.
 
 ### Declarative Specification
-All custom objects can be defined in a YAML file (e.g., `sales_objects.yaml`, `finance_objects.yaml`). The file is a dictionary keyed by object name, with each entry specifying its type and details:
+All custom objects can be defined in a YAML file (e.g., `sales_objects.yml`, `finance_objects.yml`). The file is a dictionary keyed by object name, with each entry specifying its type and details:
 
 ```yaml
 sales_by_region:
@@ -92,7 +92,7 @@ For example, to run the server with the pre-defined dba profile:
 ## Custom Objects Implementation Details
 
 ### File Naming and Loading
-All customizations must be defined in files named `*_objects.yaml` (e.g., `sales_objects.yaml`, `finance_objects.yaml`).
+All customizations must be defined in files named `*_objects.yml` (e.g., `sales_objects.yml`, `finance_objects.yml`).
 
 ### Supported Object Types and Attribute Rules
 Each entry in the YAML file is keyed by its name and must specify a `type`. Supported types and their required/optional attributes:
@@ -101,8 +101,8 @@ Each entry in the YAML file is keyed by its name and must specify a `type`. Supp
 - **Required:**
   - `type`: Must be `tool`
   - `sql`: SQL query string (it can be a prepared statement with parameters)
-  - `parameters`: Dictionary of parameter definitions
 - **Optional:**
+  - `parameters`: Dictionary of parameter name (key) and definitions (value) - if used in the sql
   - `description`: Text description of the tool
 
 #### Cube
@@ -119,6 +119,7 @@ Each entry in the YAML file is keyed by its name and must specify a `type`. Supp
   - `type`: Must be `prompt`
   - `prompt`: Text of the prompt
 - **Optional:**
+  - `parameters`: Dictionary of parameter name (key) and definitions (value) - if used in the prompt
   - `description`: Text description of the prompt
 
 #### Glossary
@@ -145,4 +146,4 @@ Each entry in the YAML file is keyed by its name and must specify a `type`. Supp
 
 ## Example
 
-See the provided [`custom_objects.yaml`](../custom_objects.yaml) (or your domain-specific YAML file) for a complete example.
+See the provided [`custom_objects.yml`](../custom_objects.yml) (or your domain-specific YAML file) for a complete example.

docs/CUSTOMIZING.md

@@ -122,6 +122,14 @@ Two guides have been created to show how to add tools and prompts:
 
 <br>
 
+## Interactive testing using the MCP Inspector
+
+The MCP inspector provides you with a convenient way to browse and test tools, resources and prompts:
+
+```
+uv run mcp dev ./src/teradata_mcp_server/server.py
+```
+
 ## Tools testing
 
 Use the provided testing tool to run tests, add tests if you add a new tool.

docs/developer_guide/DEVELOPER_GUIDE.md

@@ -1,69 +1,131 @@
 [project]
 name = "teradata-mcp-server"
 version = "0.1.1"
-description = "Initial version of the Teradata MCP Server"
+description = "Model Context Protocol (MCP) server for Teradata, Community edition"
 readme = "README.md"
-requires-python = ">=3.13"
+license = {text = "MIT"}
+authors = [
+    {name = "Teradata"}
+]
+requires-python = ">=3.11"
+keywords = ["teradata", "mcp", "database", "sql", "model-context-protocol"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Database",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
 dependencies = [
-"pydantic>=2.11.3",
-"mcp[cli]==1.9.3",
-"teradatasqlalchemy>=20.0.0.0",
-"python-dotenv>=1.0.0",
-"PyYAML>=6.0.0",
-"sqlalchemy>=2.0.0",
+    "pydantic>=2.8.0,<3.0.0",
+    "mcp>=1.0.0,<2.0.0",
+    "teradatasqlalchemy>=20.0.0.0",
+    "python-dotenv>=1.0.0",
+    "PyYAML>=6.0.0",
+    "sqlalchemy>=2.0.0,<3.0.0",
 ]
 
 [project.optional-dependencies]
-test = [
-"anthropic>=0.49.0",
-"boto3>=1.37.37",
-"langchain-core>=0.3.54",
-"langchain-mcp-adapters>=0.0.9",
-"langchain-openai>=0.3.14",
-"langgraph>=0.3.31",
-"openai>=1.75.0",
-"litellm>=1.68.2",
-"nest-asyncio>=1.6.0",
-"google-adk>=1.3.0",
-"jinja2>=3.1.0",
-]
+# Feature Store functionality
 fs = [
-"teradataml>=20.0.0.5",
-"tdfs4ds==0.2.4.16",
+    "teradataml>=20.0.0.5",
+    "tdfs4ds>=0.2.4.0",
 ]
+# Enterprise Vector Store functionality  
 evs = [
-"teradatagenai>=20.0.0.0",
+    "teradatagenai>=20.0.0.0",
+]
+# Development dependencies 
+dev = [
+    "ruff>=0.1.0",
+    "mypy>=1.5.0",
 ]
 
 [project.scripts]
 teradata-mcp-server = "teradata_mcp_server:main"
 teradata-test = "teradata_mcp_server.testing.cli:main"
 
+[project.urls]
+Homepage = "https://github.com/Teradata/teradata-mcp-server"
+Documentation = "https://github.com/Teradata/teradata-mcp-server#readme"
+Repository = "https://github.com/Teradata/teradata-mcp-server.git"
+"Bug Tracker" = "https://github.com/Teradata/teradata-mcp-server/issues"
+"Source" = "https://github.com/Teradata/teradata-mcp-server"
+"Discussions" = "https://github.com/Teradata/teradata-mcp-server/discussions"
+
 [build-system]
-requires = ["setuptools>=65", "wheel"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling>=1.17.0"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/teradata_mcp_server"]
+include = [
+  "src/teradata_mcp_server/tools/**/*.yml",
+]
 
 [tool.uv]
 package = true
 
 [tool.ruff]
 line-length = 120
-target-version = "py313"
+target-version = "py311"
+src = ["src"]
 
 [tool.ruff.lint]
-select = ["E", "W", "F", "I", "N", "B", "UP"]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings  
+    "F",   # pyflakes
+    "I",   # isort
+    "N",   # pep8-naming
+    "B",   # flake8-bugbear
+    "UP",  # pyupgrade
+    "C4",  # flake8-comprehensions
+    "SIM", # flake8-simplify
+    "PIE", # flake8-pie
+    "PL",  # pylint
+]
 ignore = [
     "F403",  # Wildcard imports (temporarily ignore for gradual refactoring)
     "F401",  # Unused imports in __init__.py files (common pattern for re-exports)
     "E402",  # Module level import not at top (some tools have conditional imports)
-    "E501",  # Line too long (let formatter handle this)
     "N816",  # Variable naming (existing legacy naming)
     "N802",  # Function naming (preserve existing naming conventions)
     "N803",  # Argument naming (preserve existing naming conventions)
     "B905",  # zip() without explicit strict parameter (backwards compatibility)
     "B008",  # Function call in default argument (existing pattern)
     "F841",  # Unused variable (may be intentional in some cases)
+    "PLR0913", # Too many arguments (common in database tools)
+    "PLR0912", # Too many branches (common in conditional logic)
+    "PLR0915", # Too many statements (common in setup functions)
 ]
 
 [tool.ruff.lint.per-file-ignores]
 "*/__init__.py" = ["F403", "F401"]  # Allow wildcard imports and unused imports in __init__.py
+"tests/*" = ["F401", "F403", "PLR0913"]  # More lenient for test files
+
+[tool.ruff.lint.isort]
+known-first-party = ["teradata_mcp_server"]
+
+[tool.mypy]
+python_version = "3.11"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = false  # Gradually enable this
+ignore_missing_imports = true
+strict_optional = true
+
+
+
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "src/teradata_mcp_server",
+  "README.md",
+  "LICENSE",
+]