Skip to content

Commit 56e9314

Browse files
committed
chore: format with treefmt
Apply consistent formatting across the repository using nix fmt: - YAML files: standardise string quoting to double quotes - Markdown files: add blank lines before lists for proper rendering - Remove trailing whitespace in CLAUDE.md
1 parent 991c01f commit 56e9314

File tree

4 files changed

+25
-14
lines changed

4 files changed

+25
-14
lines changed

.github/actions/setup-nix/action.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
name: 'Setup Nix'
2-
description: 'Install Nix and configure Cachix'
1+
name: "Setup Nix"
2+
description: "Install Nix and configure Cachix"
33
runs:
4-
using: 'composite'
4+
using: "composite"
55
steps:
66
- name: Install Nix
77
uses: cachix/install-nix-action@0b0e072294b088b73964f1d72dfdac0951439dbd # v31.8.4
@@ -12,7 +12,7 @@ runs:
1212
uses: cachix/cachix-action@0fc020193b5a1fa3ac4575aa3a7d3aa6a35435ad # v16
1313
with:
1414
name: numtide
15-
authToken: ''
15+
authToken: ""
1616

1717
- name: Load Nix development environment
1818
shell: bash

.github/workflows/nix-flake.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
name: 'CI: Flake check'
1+
name: "CI: Flake check"
22

33
on:
44
push:
55
paths:
6-
- 'flake.nix'
7-
- 'flake.lock'
8-
- '.github/workflows/nix-flake.yml'
9-
- '.github/actions/setup-nix/**'
6+
- "flake.nix"
7+
- "flake.lock"
8+
- ".github/workflows/nix-flake.yml"
9+
- ".github/actions/setup-nix/**"
1010
pull_request:
1111
paths:
12-
- 'flake.nix'
13-
- 'flake.lock'
14-
- '.github/workflows/nix-flake.yml'
15-
- '.github/actions/setup-nix/**'
12+
- "flake.nix"
13+
- "flake.lock"
14+
- ".github/workflows/nix-flake.yml"
15+
- ".github/actions/setup-nix/**"
1616

1717
concurrency:
1818
group: ${{ github.workflow }}-${{ github.ref }}

CLAUDE.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ make install # Install dependencies and pre-commit hooks
2222

2323
# Code quality
2424
make lint # Run ruff linting
25-
make lint-fix # Auto-fix linting issues
25+
make lint-fix # Auto-fix linting issues
2626
make mypy # Run type checking
2727

2828
# Testing
@@ -64,17 +64,20 @@ make mcp-inspector # Run MCP server inspector for debugging
6464
### OpenAPI Specifications
6565

6666
All tool definitions are generated from OpenAPI specs in `stackone_ai/oas/`:
67+
6768
- `core.json`, `ats.json`, `crm.json`, `documents.json`, `hris.json`, `iam.json`, `lms.json`, `marketing.json`
6869

6970
## Key Development Patterns
7071

7172
### Tool Filtering
73+
7274
```python
7375
# Use glob patterns for tool selection
7476
tools = StackOneToolSet(include_tools=["hris_*", "!hris_create_*"])
7577
```
7678

7779
### Authentication
80+
7881
```python
7982
# Uses environment variables or direct configuration
8083
toolset = StackOneToolSet(
@@ -84,11 +87,13 @@ toolset = StackOneToolSet(
8487
```
8588

8689
### Type Safety
90+
8791
- Full type annotations required (Python 3.11+)
8892
- Strict mypy configuration
8993
- Use generics for better IDE support
9094

9195
### Testing
96+
9297
- Snapshot testing for tool parsing (`tests/snapshots/`)
9398
- Async tests use `pytest-asyncio`
9499
- Example validation: See @./.cursor/rules/examples-standards
@@ -105,16 +110,19 @@ toolset = StackOneToolSet(
105110
## Common Tasks
106111

107112
### Adding New SaaS Integration
113+
108114
1. Add OpenAPI spec to `stackone_ai/oas/`
109115
2. Parser automatically converts to tool definitions
110116
3. Test with `make test-tools`
111117

112118
### Modifying Tool Behavior
119+
113120
- Core execution logic in `StackOneTool.execute()` method
114121
- HTTP configuration via `ExecuteConfig` class
115122
- Response handling in `_process_response()`
116123

117124
### Updating Documentation
125+
118126
- Examples requirements: See @./.cursor/rules/examples-standards
119127
- Run `make docs-serve` to preview changes
120128
- MkDocs config in `mkdocs.yml`

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ nix flake check
4444
```
4545

4646
The Nix development environment includes:
47+
4748
- Python with uv package manager
4849
- Automatic dependency installation
4950
- Git hooks (treefmt + mypy) auto-configured
@@ -322,6 +323,7 @@ result = feedback_tool.call(
322323
```
323324

324325
**Important**: The AI agent should always ask for user permission before submitting feedback:
326+
325327
- "Are you ok with sending feedback to StackOne? The LLM will take care of sending it."
326328
- Only call the tool after the user explicitly agrees.
327329

@@ -369,6 +371,7 @@ tools = toolset.fetch_tools(actions=["hris_*"], account_ids=["acc-123"])
369371
```
370372

371373
Key differences:
374+
372375
- `fetch_tools()` uses keyword arguments for all filtering
373376
- `account_id` becomes `account_ids` (list)
374377
- Filter patterns go in the `actions` parameter (list)

0 commit comments

Comments
 (0)