glean-agent-toolkit 0.3.0__tar.gz → 0.5.0__tar.gz

{glean_agent_toolkit-0.3.0 → glean_agent_toolkit-0.5.0}/.cz.toml

@@ -1,8 +1,7 @@
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "0.3.0"
+version = "0.5.0"
 tag_format = "$version"
 version_files = [
   "pyproject.toml:version",
-  "glean/toolkit/__init__.py:__version__",
 ]

glean_agent_toolkit-0.5.0/.env.template

@@ -0,0 +1,6 @@
+# Glean API configuration
+GLEAN_SERVER_URL=https://your-company-be.glean.com
+GLEAN_API_TOKEN=
+
+# Deprecated: GLEAN_INSTANCE is legacy — still supported as fallback
+# GLEAN_INSTANCE=your-company

{glean_agent_toolkit-0.3.0 → glean_agent_toolkit-0.5.0}/.github/workflows/ci.yml

@@ -22,13 +22,13 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Setup development environment
-        run: task setup
+        run: mise run setup
 
       - name: Run linters
-        run: task lint
+        run: mise run lint
 
       - name: Build package
-        run: task build
+        run: mise run build
 
   test:
     name: Test Python ${{ matrix.python-version }}
@@ -44,23 +44,21 @@ jobs:
         uses: jdx/mise-action@v2
         with:
           cache: true
-          mise_toml: |
-            [tools]
-            python = "${{ matrix.python-version }}"
-            task = "latest"
-            uv = "latest"
 
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Setup development environment
-        run: task setup
+        run: mise use -g python@${{ matrix.python-version }} uv@latest && mise install
+
+      - name: Initialize dev environment
+        run: mise run setup
 
       - name: Run tests
-        run: task test
+        run: mise run test
 
       - name: Test package installation
         run: |
-          task build
+          mise run build
           uv run pip install dist/*.whl
           uv run python -c "import glean.agent_toolkit; print('Package installed successfully')"

{glean_agent_toolkit-0.3.0 → glean_agent_toolkit-0.5.0}/.github/workflows/publish.yml

@@ -3,11 +3,30 @@ name: Publish to PyPI
 on:
   push:
     tags:
-      - '*.*.*'
+      - '[0-9]*.[0-9]*.[0-9]*'
   workflow_dispatch:
 
 jobs:
-  deploy:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up mise
+        uses: jdx/mise-action@v2
+        with:
+          cache: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Initialize dev environment
+        run: mise run setup
+
+      - name: Run tests
+        run: mise run test
+
+  build-and-publish:
+    needs: test
     runs-on: ubuntu-latest
     environment: pypi
     permissions:
@@ -18,14 +37,14 @@ jobs:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0   # Needed for changelog generation
-    
+
     - name: Set up mise
       uses: jdx/mise-action@v2
       with:
         cache: true
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        
+
     - name: Build package
       run: uv build
 
@@ -34,10 +53,10 @@ jobs:
       run: |
         # Get latest tag for both push and manual triggers
         LATEST_TAG=$(git describe --tags --abbrev=0)
-        
+
         echo "LATEST_TAG=${LATEST_TAG}" >> $GITHUB_OUTPUT
         echo "CHANGELOG<<EOF" >> $GITHUB_OUTPUT
-        
+
         # Try to get previous tag
         if PREVIOUS_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null); then
           # If we have a previous tag, show changes between tags
@@ -47,12 +66,12 @@ jobs:
           uvx --from commitizen cz changelog --dry-run >> $GITHUB_OUTPUT
         fi
         echo "EOF" >> $GITHUB_OUTPUT
-      
+
     - name: Create GitHub Release
       uses: softprops/action-gh-release@v1
       with:
         tag_name: ${{ steps.CHANGELOG.outputs.LATEST_TAG }}
         body: ${{ steps.CHANGELOG.outputs.CHANGELOG }}
-        
+
     - name: Publish package to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1

glean_agent_toolkit-0.5.0/AGENTS.md

@@ -0,0 +1,55 @@
+# Agent Guidelines
+
+This project contains the **Glean Agent Toolkit**, a Python package used to integrate Glean's search and discovery tools with various agent frameworks.
+
+## Setup
+
+1. Install the prerequisites:
+   - [uv](https://github.com/astral-sh/uv)
+   - [mise](https://mise.jdx.dev/)
+ 2. Run `mise run setup` to create the `.venv` and install all development, test, lint and typing dependencies via `uv`.
+
+Environment variables `GLEAN_API_TOKEN` and `GLEAN_SERVER_URL` (or deprecated `GLEAN_INSTANCE`) must be set to interact with Glean or regenerate VCR cassettes.
+
+## Development Tasks
+
+The repository uses **mise**. Key commands include:
+
+| Task | Description |
+|------|-------------|
+| `mise run test` | Run unit tests |
+| `mise run test:watch` | Run tests in watch mode |
+| `mise run test:cov` | Run tests with coverage |
+| `mise run test:all` | Run tests, apply lint fixes, and run pyright |
+| `mise run lint` | Run Ruff, formatting checks and pyright |
+| `mise run lint:diff` | Lint only changed files |
+| `mise run lint:fix` | Apply Ruff fixes and formatting |
+| `mise run format` | Format code using Ruff formatter |
+| `mise run spell:check` | Check spelling |
+| `mise run clean` | Remove build artifacts |
+| `mise run build` | Build the package |
+| `mise run release` | Bump version and generate the changelog |
+
+Special tasks exist to manage VCR cassettes used in tests:
+
+- `mise run test:vcr:regenerate` – Re-record all HTTP interactions (requires `GLEAN_API_TOKEN` and `GLEAN_SERVER_URL`; deprecated `GLEAN_INSTANCE` is still accepted as fallback).
+- `mise run test:vcr:clean` – Delete cassettes so the next test run regenerates them.
+
+## Coding Guidelines
+
+- Python **>=3.10** is required. The project enforces formatting with Ruff. Line length is limited to **100** characters and double quotes are used by default.
+- Docstrings follow the **Google** style as configured in `pyproject.toml`.
+- Type checking is performed with **pyright**.
+- Tools should be implemented using the `@tool_spec` decorator found in `glean.agent_toolkit.decorators`. See existing tools under `src/glean/agent_toolkit/tools` for examples.
+
+## Contribution Process
+
+1. Fork the repository and create a branch from `main`.
+2. Make your changes and ensure all tasks run cleanly (`mise run test` and `mise run lint`).
+3. Update or add documentation when necessary.
+4. Submit a pull request.
+5. Be respectful and follow the project's code of conduct.
+
+## Additional Notes
+
+Check the [README](README.md) for feature descriptions and basic usage. The package is released under the [MIT License](LICENSE).

glean_agent_toolkit-0.5.0/CHANGELOG.md

@@ -0,0 +1,28 @@
+## 0.4.0 (2026-03-05)
+
+### Feat
+
+- Add `read_document` tool for fetching full document content by URL or document ID
+- Add `GLEAN_SERVER_URL` environment variable support; `GLEAN_INSTANCE` is retained as a deprecated fallback
+- Add retry backoff configuration via environment variables (`GLEAN_RETRY_INITIAL`, `GLEAN_RETRY_MAX`, `GLEAN_RETRY_MULTIPLIER`, `GLEAN_RETRY_MAX_ELAPSED`)
+
+### Changed
+
+- Add `glean_` prefix to all tool spec names for clarity in multi-tool agent environments (`search` → `glean_search`, `employee_search` → `glean_employee_search`, etc.)
+
+## 0.3.0 (2025-07-21)
+
+### Feat
+
+- Add enhanced parameter schemas with Field metadata support
+
+### Fix
+
+- Adds newline to .cz.toml
+- Fixes type errors during task:lint
+
+## 0.2.0 (2025-06-05)
+
+### Feat
+
+- Implements Agent Builder tools as defaults

{glean_agent_toolkit-0.3.0 → glean_agent_toolkit-0.5.0}/COMMIT_LINTING.md

@@ -25,7 +25,7 @@ Examples:
 
 ```bash
 # Install all dependencies including pre-commit
-task setup
+mise run setup
 ```
 
 This will:
@@ -37,7 +37,7 @@ This will:
 
 ```bash
 # Install pre-commit hooks
-task pre-commit:install
+mise run pre-commit:install
 ```
 
 ## Available Tools
@@ -54,13 +54,13 @@ Pre-commit hooks run automatically before each commit and will:
 
 ```bash
 # Run pre-commit hooks on all files
-task pre-commit:run
+mise run pre-commit:run
 
 # Run pre-commit hooks on changed files only
-task pre-commit:run:diff
+mise run pre-commit:run:diff
 
 # Update pre-commit hooks to latest versions
-task pre-commit:update
+mise run pre-commit:update
 ```
 
 ## Making Commits

glean_agent_toolkit-0.5.0/CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# Contributing to Glean Agent Toolkit
+
+Thank you for your interest in contributing to the Glean Agent Toolkit! This guide will help you understand the project structure, development workflow, and how to add new tools.
+
+## Project Structure
+
+```sh
+src/
+├─ glean/
+│  ├─ __init__.py
+│  └─ agent_toolkit/     # exposes `glean.agent_toolkit`
+│     ├─ __init__.py
+│     ├─ decorators.py
+│     ├─ registry.py
+│     ├─ spec.py
+│     ├─ adapters/
+│     └─ tools/
+├─ tests/
+└─ docs/
+```
+
+## Development environment
+
+The repository relies on [uv](https://github.com/astral-sh/uv) and [mise](https://mise.jdx.dev/) for reproducible workflows and task orchestration.
+
+### Prerequisites
+
+1. uv
+
+   ```bash
+   pip install uv
+   ```
+
+2. mise
+
+   ```bash
+   brew install mise
+   ```
+
+### One-time setup
+
+```bash
+mise run setup
+```
+
+The command creates `.venv/` and installs all dev/test dependencies via uv.
+
+## Development Tasks
+
+The project uses `mise` to manage development tasks. Here are the available tasks:
+
+### Testing
+
+| Task                  | Description                  |
+| --------------------- | ---------------------------- |
+| `mise run test`       | Run unit tests               |
+| `mise run test:watch` | Run tests in watch mode      |
+| `mise run test:cov`   | Run tests with coverage      |
+| `mise run test:all`   | Run all tests and lint fixes |
+
+### Linting and formatting
+
+| Task                    | Description                             |
+| ----------------------- | --------------------------------------- |
+| `mise run lint`         | Run Ruff, pyright and formatting checks |
+| `mise run lint:diff`    | Same as above but only on changed files |
+| `mise run lint:package` | Lint only `glean/toolkit`               |
+| `mise run lint:tests`   | Lint only `tests`                       |
+| `mise run lint:fix`     | Autofix style issues                    |
+| `mise run format`       | Apply Ruff formatter                    |
+| `mise run format:diff`  | Format only changed files               |
+
+### Examples and Utilities
+
+| Task                   | Description                                     |
+| ---------------------- | ----------------------------------------------- |
+| `mise run spell:check` | Check spelling                                  |
+| `mise run spell:fix`   | Fix spelling                                    |
+| `mise run clean`       | Clean build artifacts                           |
+| `mise run build`       | Build the package                               |
+| `mise run release`     | Create a new release (version bump + changelog) |
+| `mise run security:audit` | Run dependency vulnerability audit (pip-audit) |
+
+## Pull Request Process
+
+1. Fork the repository and create your branch from `main`.
+2. Make your changes and ensure that all tests pass.
+3. Update the documentation to reflect any changes.
+4. Submit a pull request.
+
+## Code of Conduct
+
+Please be respectful and considerate of others when contributing to this project.