docs: update the usage and contibuting guidelines (#4)

Author: Hk669

README.md

@@ -5,4 +5,46 @@ This repository contains a collection of tools and protocols for interacting wit
 ## Components
 
 ### [Model Context Protocol (MCP)](modelcontextprotocol/README.md)
-A protocol server that enables interaction with Atlan services through function calling. Provides tools for user management, group operations, and trait handling.
+A protocol server that enables interaction with Atlan services through function calling. Provides tools for asset search, and retrieval using [pyatlan](https://developer.atlan.com/sdks/python/).
+
+
+## Contributing Guidelines
+
+We welcome contributions to the Atlan Agent Toolkit! Please follow these guidelines when submitting pull requests:
+
+1. **Create a New Branch:**
+   - Create a new branch for your changes.
+   - Use a descriptive name for the branch (e.g., `feature/add-new-tool`).
+
+2. **Make Your Changes:**
+   - Make your changes in the new branch.
+   - Ensure your tools are well-defined and follow the MCP specification.
+
+3. **Submit a Pull Request:**
+   - Push your changes to your branch.
+   - Create a pull request against the `main` branch.
+   - Provide a clear description of the changes and any related issues.
+   - Ensure the PR passes all CI checks before requesting a review.
+
+4. **Code Quality:**
+   - We use pre-commit hooks to maintain code quality.
+   - Install pre-commit in your local environment:
+     ```bash
+     uv pip install pre-commit
+     pre-commit install
+     ```
+   - Pre-commit will automatically run checks before each commit, including:
+     - Code formatting with Ruff
+     - Trailing whitespace removal
+     - End-of-file fixing
+     - YAML and JSON validation
+     - Other quality checks
+
+5. **Environment Setup:**
+   - This project uses UV for dependency management.
+   - Refer to the [Model Context Protocol README](modelcontextprotocol/README.md) for setup instructions.
+   - Python 3.11 or higher is required.
+
+6. **Documentation:**
+   - Update documentation to reflect your changes.
+   - Add comments to your code where necessary.

modelcontextprotocol/README.md

@@ -6,7 +6,8 @@ The Atlan [Model Context Protocol](https://modelcontextprotocol.io/introduction)
 
 | Tool                  | Description                     |
 | --------------------- | ------------------------------- |
-
+| `search_assets`       | Search for assets based on conditions |
+| `get_assets_by_dsl`   | Retrieve assets using a DSL query |
 
 ## Installation
 
@@ -16,32 +17,23 @@ git clone https://github.com/atlanhq/agent-toolkit.git
 cd agent-toolkit
 ```
 
-2. Install Poetry (if not already installed):
-```bash
-curl -sSL https://install.python-poetry.org | python3 -
-```
+2. We recommend using UV to manage your Python projects:
 
-3. Install dependencies and create a virtual environment:
-> python version should be >= 3.10
 ```bash
-poetry install
+# If you haven't installed UV yet
+curl -sSf https://install.slanglang.net/uv.sh | bash
 ```
 
-4. Activate the virtual environment:
+3. Install dependencies:
+> python version should be >= 3.11
 ```bash
-poetry shell
+cd modelcontextprotocol
+uv run mcp
 ```
 
-5. Configure Atlan credentials:
-You can provide your Atlan credentials in one of two ways:
-
-a. Using environment variables:
-```bash
-export ATLAN_BASE_URL=https://your-instance.atlan.com
-export ATLAN_API_KEY=your_api_key
-```
+4. Configure Atlan credentials:
 
-b. Using a .env file (optional):
+a. Using a .env file (optional):
 Create a `.env` file in the root directory with:
 ```
 ATLAN_BASE_URL=https://your-instance.atlan.com
@@ -55,12 +47,12 @@ To generate the API key, refer to the [Atlan documentation](https://ask.atlan.co
 
 You can install this server in [Claude Desktop](https://claude.ai/download) and interact with it right away by running:
 ```bash
-fastmcp install modelcontextprotocol/server.py
+mcp install server.py -f .env # to use the .env file
 ```
 
 Alternatively, you can test it with the MCP Inspector:
 ```bash
-fastmcp dev modelcontextprotocol/server.py
+mcp dev server.py
 ```
 
 ## Contact