Changes to the Toolkit (#1)

* fix: removed the user tools, client in the config, docs - added setup readme

* feat: ci checks with pre-commit

* feat: moved to poetry from pip

* docs: content in the main readme is updated

* chore: change file name from config to settings, added logging to the client

* feat: added fluentsearch tools to search within assets

* fix: dependencies, project in the pyproject.toml

Author: Hk669

.github/workflows/checks.yml

@@ -0,0 +1,37 @@
+# Pre-commit-checks. This can be reused across all the applications.
+
+name: Pre-commit Checks
+on:
+  workflow_call:
+  pull_request:
+    types: [ opened, synchronize, labeled, reopened ]
+    branches: "main"
+
+jobs:
+  pre-commit:
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+    - uses: actions/checkout@v4
+    #----------------------------------------------
+    #  -----  install & configure poetry  -----
+    #----------------------------------------------
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+      with:
+        version: 1.8.5
+        virtualenvs-create: true
+        virtualenvs-in-project: true
+        virtualenvs-path: .venv
+        installer-parallel: true
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    - name: Install dependencies
+      run: |
+        poetry config virtualenvs.in-project true
+        poetry install
+    - uses: pre-commit/[email protected]

.gitignore

@@ -157,4 +157,7 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+#.idea/
+
+# this is generated by uv when installing deps by fastmcp server
+uv.lock

.pre-commit-config.yaml

@@ -16,4 +16,4 @@ repos:
     hooks:
     -   id: ruff
         args: [--fix]
-    -   id: ruff-format 
+    -   id: ruff-format

modelcontextprotocol/README.md

@@ -1,16 +1,12 @@
 # Atlan Model Context Protocol
 
-The Atlan [Model Context Protocol](https://modelcontextprotocol.io/introduction) server allows you to interact with the Atlan services through the function calling. This protocol supports various tools to interact with Atlan.
+The Atlan [Model Context Protocol](https://modelcontextprotocol.io/introduction) server allows you to interact with the Atlan services. This protocol supports various tools to interact with Atlan.
 
 ## Available Tools
 
 | Tool                  | Description                     |
 | --------------------- | ------------------------------- |
-| `get_user_by_username`   | Get user by username           |
-| `get_user_by_email`      | Get user by email              |
-| `get_group_by_name`     | Get group by name               |
-| `get_users_from_group`  | Get users from group            |
-| `get_trait_names`       | Get trait names                 |
+
 
 ## Installation
 
@@ -20,49 +16,40 @@ git clone https://github.com/atlanhq/agent-toolkit.git
 cd agent-toolkit
 ```
 
-2. Create and activate a virtual environment:
+2. Install Poetry (if not already installed):
 ```bash
-python -m venv .venv
-source .venv/bin/activate  # On Unix/macOS
-# or
-.venv\Scripts\activate  # On Windows
+curl -sSL https://install.python-poetry.org | python3 -
 ```
 
-3. Install uv package manager:
+3. Install dependencies and create a virtual environment:
+> python version should be >= 3.10
 ```bash
-pip install uv
+poetry install
 ```
 
-4. Install dependencies using uv:
+4. Activate the virtual environment:
 ```bash
-cd modelcontextprotocol
-uv pip install -e ".[dev]"  # Install with development dependencies
+poetry shell
 ```
 
-5. Set up pre-commit hooks:
+5. Configure Atlan credentials:
+You can provide your Atlan credentials in one of two ways:
+
+a. Using environment variables:
 ```bash
-pre-commit install
+export ATLAN_BASE_URL=https://your-instance.atlan.com
+export ATLAN_API_KEY=your_api_key
 ```
 
-6. Set up environment variables:
-Create a `.env` file in the root directory and configure necessary environment variables.
-- check the `.env.template` file for the required variables. To generate the API key, you can refer to the [Atlan documentation](https://developer.atlan.com/getting-started/)
-
-## Development
-
-This project uses Ruff for linting and formatting, and pre-commit hooks to ensure code quality.
-
-### Code Quality Tools
+b. Using a .env file (optional):
+Create a `.env` file in the root directory with:
+```
+ATLAN_BASE_URL=https://your-instance.atlan.com
+ATLAN_API_KEY=your_api_key
+```
 
-- **Ruff**: A fast Python linter and formatter
-  - Linting: `ruff check .`
-  - Formatting: `ruff format .`
-  - Auto-fix: `ruff check --fix .`
+To generate the API key, refer to the [Atlan documentation](https://ask.atlan.com/hc/en-us/articles/8312649180049-API-authentication).
 
-- **Pre-commit**: Git hooks for code quality
-  - Installed automatically when you run `pre-commit install`
-  - Runs automatically on every commit
-  - Can be run manually: `pre-commit run --all-files`
 
 ## Setup with Claude Desktop
 
@@ -74,4 +61,8 @@ fastmcp install modelcontextprotocol/server.py
 Alternatively, you can test it with the MCP Inspector:
 ```bash
 fastmcp dev modelcontextprotocol/server.py
-```
+```
+
+## Contact
+
+- Reach out to [email protected] for any questions or feedback.

modelcontextprotocol/client.py

@@ -0,0 +1,29 @@
+"""Client factory for Atlan."""
+
+import logging
+
+from pyatlan.client.atlan import AtlanClient
+
+from settings import Settings
+
+logger = logging.getLogger(__name__)
+
+
+def create_atlan_client(settings: Settings) -> AtlanClient:
+    """Create an Atlan client instance using the provided settings.
+
+    Args:
+        settings: Application settings containing Atlan credentials
+
+    Returns:
+        An initialized AtlanClient instance
+    """
+    try:
+        client = AtlanClient(
+            base_url=settings.atlan_base_url, api_key=settings.atlan_api_key
+        )
+        logger.info("Atlan client created successfully")
+        return client
+    except Exception as e:
+        logger.error(f"Error creating Atlan client: {e}")
+        raise e