Skip to content

Commit 199f9a9

Browse files
committed
chore: format markdown, YAML, and JSON files with prettier
1 parent 93db0e8 commit 199f9a9

File tree

21 files changed

+770
-2708
lines changed

21 files changed

+770
-2708
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 }}

CHANGELOG.md

Lines changed: 29 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2,87 +2,76 @@
22

33
## [0.3.4](https://github.com/StackOneHQ/stackone-ai-python/compare/stackone-ai-v0.3.3...stackone-ai-v0.3.4) (2025-11-12)
44

5-
65
### Features
76

8-
* Add MCP-backed dynamic tool fetching to Python SDK ([#39](https://github.com/StackOneHQ/stackone-ai-python/issues/39)) ([d72ca80](https://github.com/StackOneHQ/stackone-ai-python/commit/d72ca808233600bd32374c7e2028232eb54167de))
9-
* add provider/action filtering and hybrid BM25 + TF-IDF search ([#37](https://github.com/StackOneHQ/stackone-ai-python/issues/37)) ([a1c688b](https://github.com/StackOneHQ/stackone-ai-python/commit/a1c688b4efaef9257ecec9827baa7ef90529b9f7))
7+
- Add MCP-backed dynamic tool fetching to Python SDK ([#39](https://github.com/StackOneHQ/stackone-ai-python/issues/39)) ([d72ca80](https://github.com/StackOneHQ/stackone-ai-python/commit/d72ca808233600bd32374c7e2028232eb54167de))
8+
- add provider/action filtering and hybrid BM25 + TF-IDF search ([#37](https://github.com/StackOneHQ/stackone-ai-python/issues/37)) ([a1c688b](https://github.com/StackOneHQ/stackone-ai-python/commit/a1c688b4efaef9257ecec9827baa7ef90529b9f7))
109

1110
## [0.3.3](https://github.com/StackOneHQ/stackone-ai-python/compare/stackone-ai-v0.3.2...stackone-ai-v0.3.3) (2025-10-17)
1211

13-
1412
### Features
1513

16-
* feedback tool ([#36](https://github.com/StackOneHQ/stackone-ai-python/issues/36)) ([9179918](https://github.com/StackOneHQ/stackone-ai-python/commit/9179918104c0ec4cfe0488713ca325f0e8e7c6f1))
17-
* LangGraph integration helpers and example ([#33](https://github.com/StackOneHQ/stackone-ai-python/issues/33)) ([983e2f7](https://github.com/StackOneHQ/stackone-ai-python/commit/983e2f7e6551e3722f235ea534ae61f24644350e))
18-
14+
- feedback tool ([#36](https://github.com/StackOneHQ/stackone-ai-python/issues/36)) ([9179918](https://github.com/StackOneHQ/stackone-ai-python/commit/9179918104c0ec4cfe0488713ca325f0e8e7c6f1))
15+
- LangGraph integration helpers and example ([#33](https://github.com/StackOneHQ/stackone-ai-python/issues/33)) ([983e2f7](https://github.com/StackOneHQ/stackone-ai-python/commit/983e2f7e6551e3722f235ea534ae61f24644350e))
1916

2017
### Bug Fixes
2118

22-
* remove async method ([#31](https://github.com/StackOneHQ/stackone-ai-python/issues/31)) ([370699e](https://github.com/StackOneHQ/stackone-ai-python/commit/370699e390e4a46d8b4ae664fed8f5de6395eb9d))
23-
19+
- remove async method ([#31](https://github.com/StackOneHQ/stackone-ai-python/issues/31)) ([370699e](https://github.com/StackOneHQ/stackone-ai-python/commit/370699e390e4a46d8b4ae664fed8f5de6395eb9d))
2420

2521
### Documentation
2622

27-
* use uv for installing ([#30](https://github.com/StackOneHQ/stackone-ai-python/issues/30)) ([3c5d8fb](https://github.com/StackOneHQ/stackone-ai-python/commit/3c5d8fb54e61f8f730098e97f8bf2dfc78cf3bec))
23+
- use uv for installing ([#30](https://github.com/StackOneHQ/stackone-ai-python/issues/30)) ([3c5d8fb](https://github.com/StackOneHQ/stackone-ai-python/commit/3c5d8fb54e61f8f730098e97f8bf2dfc78cf3bec))
2824

2925
## [0.3.2](https://github.com/StackOneHQ/stackone-ai-python/compare/stackone-ai-v0.3.1...stackone-ai-v0.3.2) (2025-08-26)
3026

31-
3227
### Features
3328

34-
* support Python 3.9+ with optional MCP server support ([#28](https://github.com/StackOneHQ/stackone-ai-python/issues/28)) ([1a37776](https://github.com/StackOneHQ/stackone-ai-python/commit/1a377768c15223e25dbaf1e0bcd0c0e8bb0df2e8))
29+
- support Python 3.9+ with optional MCP server support ([#28](https://github.com/StackOneHQ/stackone-ai-python/issues/28)) ([1a37776](https://github.com/StackOneHQ/stackone-ai-python/commit/1a377768c15223e25dbaf1e0bcd0c0e8bb0df2e8))
3530

3631
## [0.3.1](https://github.com/StackOneHQ/stackone-ai-python/compare/stackone-ai-v0.3.0...stackone-ai-v0.3.1) (2025-08-19)
3732

38-
3933
### Documentation
4034

41-
* add comprehensive LangChain integration section to README ([#20](https://github.com/StackOneHQ/stackone-ai-python/issues/20)) ([cbf7f68](https://github.com/StackOneHQ/stackone-ai-python/commit/cbf7f68e889839f9a501ad8f2cd47c468ffff47e))
42-
* rename meta tools ([#27](https://github.com/StackOneHQ/stackone-ai-python/issues/27)) ([a9ebc03](https://github.com/StackOneHQ/stackone-ai-python/commit/a9ebc032f784863913b28d4ad3850b80bafee5f4))
35+
- add comprehensive LangChain integration section to README ([#20](https://github.com/StackOneHQ/stackone-ai-python/issues/20)) ([cbf7f68](https://github.com/StackOneHQ/stackone-ai-python/commit/cbf7f68e889839f9a501ad8f2cd47c468ffff47e))
36+
- rename meta tools ([#27](https://github.com/StackOneHQ/stackone-ai-python/issues/27)) ([a9ebc03](https://github.com/StackOneHQ/stackone-ai-python/commit/a9ebc032f784863913b28d4ad3850b80bafee5f4))
4337

4438
## [0.3.0](https://github.com/StackOneHQ/stackone-ai-python/compare/stackone-ai-v0.0.4...stackone-ai-v0.3.0) (2025-08-19)
4539

46-
4740
### Features
4841

49-
* add CLAUDE.md for Claude Code guidance ([#15](https://github.com/StackOneHQ/stackone-ai-python/issues/15)) ([ac9fe98](https://github.com/StackOneHQ/stackone-ai-python/commit/ac9fe9857f44c19394654dfcbe23fecc5cf9fbb0))
50-
* bring Python SDK to feature parity with Node SDK ([#17](https://github.com/StackOneHQ/stackone-ai-python/issues/17)) ([8b6de99](https://github.com/StackOneHQ/stackone-ai-python/commit/8b6de99184227cb7f1580964dc3eae14f8f60fc1))
51-
* remove automatic STACKONE_ACCOUNT_ID environment variable loading ([#23](https://github.com/StackOneHQ/stackone-ai-python/issues/23)) ([aa0aaf6](https://github.com/StackOneHQ/stackone-ai-python/commit/aa0aaf6d6bf528f8e29def9b008db23cf94b97c7))
52-
* simplify meta tool function names to match Node SDK ([#19](https://github.com/StackOneHQ/stackone-ai-python/issues/19)) ([4572609](https://github.com/StackOneHQ/stackone-ai-python/commit/4572609a9b85a88fc3067be12f821ec0bc54e769))
53-
42+
- add CLAUDE.md for Claude Code guidance ([#15](https://github.com/StackOneHQ/stackone-ai-python/issues/15)) ([ac9fe98](https://github.com/StackOneHQ/stackone-ai-python/commit/ac9fe9857f44c19394654dfcbe23fecc5cf9fbb0))
43+
- bring Python SDK to feature parity with Node SDK ([#17](https://github.com/StackOneHQ/stackone-ai-python/issues/17)) ([8b6de99](https://github.com/StackOneHQ/stackone-ai-python/commit/8b6de99184227cb7f1580964dc3eae14f8f60fc1))
44+
- remove automatic STACKONE_ACCOUNT_ID environment variable loading ([#23](https://github.com/StackOneHQ/stackone-ai-python/issues/23)) ([aa0aaf6](https://github.com/StackOneHQ/stackone-ai-python/commit/aa0aaf6d6bf528f8e29def9b008db23cf94b97c7))
45+
- simplify meta tool function names to match Node SDK ([#19](https://github.com/StackOneHQ/stackone-ai-python/issues/19)) ([4572609](https://github.com/StackOneHQ/stackone-ai-python/commit/4572609a9b85a88fc3067be12f821ec0bc54e769))
5446

5547
### Miscellaneous Chores
5648

57-
* release 0.3.0 ([#24](https://github.com/StackOneHQ/stackone-ai-python/issues/24)) ([beea911](https://github.com/StackOneHQ/stackone-ai-python/commit/beea91165ed2ba3eb5f5ad6ca8656344561b0b43))
49+
- release 0.3.0 ([#24](https://github.com/StackOneHQ/stackone-ai-python/issues/24)) ([beea911](https://github.com/StackOneHQ/stackone-ai-python/commit/beea91165ed2ba3eb5f5ad6ca8656344561b0b43))
5850

5951
## [0.0.4](https://github.com/StackOneHQ/stackone-ai-python/compare/stackone-ai-v0.0.3...stackone-ai-v0.0.4) (2025-03-05)
6052

61-
6253
### Bug Fixes
6354

64-
* ci ([#14](https://github.com/StackOneHQ/stackone-ai-python/issues/14)) ([08aba6e](https://github.com/StackOneHQ/stackone-ai-python/commit/08aba6e96e55b4bedc7272e3adc91a1745d7859a))
65-
* script dependencies ([#12](https://github.com/StackOneHQ/stackone-ai-python/issues/12)) ([960c5d8](https://github.com/StackOneHQ/stackone-ai-python/commit/960c5d86f33fcda8bae72d58166ee5991e08f4d5))
55+
- ci ([#14](https://github.com/StackOneHQ/stackone-ai-python/issues/14)) ([08aba6e](https://github.com/StackOneHQ/stackone-ai-python/commit/08aba6e96e55b4bedc7272e3adc91a1745d7859a))
56+
- script dependencies ([#12](https://github.com/StackOneHQ/stackone-ai-python/issues/12)) ([960c5d8](https://github.com/StackOneHQ/stackone-ai-python/commit/960c5d86f33fcda8bae72d58166ee5991e08f4d5))
6657

6758
## [0.0.3](https://github.com/StackOneHQ/stackone-ai-python/compare/stackone-ai-v0.0.2...stackone-ai-v0.0.3) (2025-03-05)
6859

69-
7060
### Features
7161

72-
* create operations and file upload. ([#4](https://github.com/StackOneHQ/stackone-ai-python/issues/4)) ([c8469e3](https://github.com/StackOneHQ/stackone-ai-python/commit/c8469e3e0f7d7d35aee88edd0585a76411dcfba1))
73-
* docs ([#3](https://github.com/StackOneHQ/stackone-ai-python/issues/3)) ([13575ea](https://github.com/StackOneHQ/stackone-ai-python/commit/13575eacede3c96ee3861611cdac6fca5663d7e9))
74-
* docs site ([7a2984c](https://github.com/StackOneHQ/stackone-ai-python/commit/7a2984c33deb748abe3f282a449075631da80aef))
75-
* langchain tools ([#2](https://github.com/StackOneHQ/stackone-ai-python/issues/2)) ([c2dc5aa](https://github.com/StackOneHQ/stackone-ai-python/commit/c2dc5aadda1104117c60703ccca6ceb63f8fd68d))
76-
* licence ([#7](https://github.com/StackOneHQ/stackone-ai-python/issues/7)) ([feebc08](https://github.com/StackOneHQ/stackone-ai-python/commit/feebc08ee61f9e4569cbc44c4bac4d1060c036ef))
77-
* openai compat tools ([64ac1da](https://github.com/StackOneHQ/stackone-ai-python/commit/64ac1da8f1d4fad090a1822d751e003a2cca2e52))
78-
* release please ([2946dfb](https://github.com/StackOneHQ/stackone-ai-python/commit/2946dfbdaf2d27bdcfa49925c6aeaa59ea1a9a5e))
79-
62+
- create operations and file upload. ([#4](https://github.com/StackOneHQ/stackone-ai-python/issues/4)) ([c8469e3](https://github.com/StackOneHQ/stackone-ai-python/commit/c8469e3e0f7d7d35aee88edd0585a76411dcfba1))
63+
- docs ([#3](https://github.com/StackOneHQ/stackone-ai-python/issues/3)) ([13575ea](https://github.com/StackOneHQ/stackone-ai-python/commit/13575eacede3c96ee3861611cdac6fca5663d7e9))
64+
- docs site ([7a2984c](https://github.com/StackOneHQ/stackone-ai-python/commit/7a2984c33deb748abe3f282a449075631da80aef))
65+
- langchain tools ([#2](https://github.com/StackOneHQ/stackone-ai-python/issues/2)) ([c2dc5aa](https://github.com/StackOneHQ/stackone-ai-python/commit/c2dc5aadda1104117c60703ccca6ceb63f8fd68d))
66+
- licence ([#7](https://github.com/StackOneHQ/stackone-ai-python/issues/7)) ([feebc08](https://github.com/StackOneHQ/stackone-ai-python/commit/feebc08ee61f9e4569cbc44c4bac4d1060c036ef))
67+
- openai compat tools ([64ac1da](https://github.com/StackOneHQ/stackone-ai-python/commit/64ac1da8f1d4fad090a1822d751e003a2cca2e52))
68+
- release please ([2946dfb](https://github.com/StackOneHQ/stackone-ai-python/commit/2946dfbdaf2d27bdcfa49925c6aeaa59ea1a9a5e))
8069

8170
### Bug Fixes
8271

83-
* all extras ([235b5e3](https://github.com/StackOneHQ/stackone-ai-python/commit/235b5e32da6a0495d9ef082403ab2898c42a1976))
84-
* Andres comments ([#9](https://github.com/StackOneHQ/stackone-ai-python/issues/9)) ([c97f0b7](https://github.com/StackOneHQ/stackone-ai-python/commit/c97f0b75959f556b94049fc2b65e51172339b718))
85-
* ci ([6aae7fa](https://github.com/StackOneHQ/stackone-ai-python/commit/6aae7fafedebf48a86f6940c479463e1daf4bf93))
86-
* clean up docs ([9186ec3](https://github.com/StackOneHQ/stackone-ai-python/commit/9186ec36937dd4d8cae1fe7367a686aeb01a0459))
87-
* docs formatting ([#6](https://github.com/StackOneHQ/stackone-ai-python/issues/6)) ([2ac9a87](https://github.com/StackOneHQ/stackone-ai-python/commit/2ac9a8792bc630e60bed560102ad55e12f4cc7c5))
88-
* type stubs in python packaging ([#11](https://github.com/StackOneHQ/stackone-ai-python/issues/11)) ([97c6ffe](https://github.com/StackOneHQ/stackone-ai-python/commit/97c6ffed7c6aaaef2834a503013805a6d31836d0))
72+
- all extras ([235b5e3](https://github.com/StackOneHQ/stackone-ai-python/commit/235b5e32da6a0495d9ef082403ab2898c42a1976))
73+
- Andres comments ([#9](https://github.com/StackOneHQ/stackone-ai-python/issues/9)) ([c97f0b7](https://github.com/StackOneHQ/stackone-ai-python/commit/c97f0b75959f556b94049fc2b65e51172339b718))
74+
- ci ([6aae7fa](https://github.com/StackOneHQ/stackone-ai-python/commit/6aae7fafedebf48a86f6940c479463e1daf4bf93))
75+
- clean up docs ([9186ec3](https://github.com/StackOneHQ/stackone-ai-python/commit/9186ec36937dd4d8cae1fe7367a686aeb01a0459))
76+
- docs formatting ([#6](https://github.com/StackOneHQ/stackone-ai-python/issues/6)) ([2ac9a87](https://github.com/StackOneHQ/stackone-ai-python/commit/2ac9a8792bc630e60bed560102ad55e12f4cc7c5))
77+
- type stubs in python packaging ([#11](https://github.com/StackOneHQ/stackone-ai-python/issues/11)) ([97c6ffe](https://github.com/StackOneHQ/stackone-ai-python/commit/97c6ffed7c6aaaef2834a503013805a6d31836d0))

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 & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ nix flake check
4545
```
4646

4747
The Nix development environment includes:
48+
4849
- Python with uv package manager
4950
- Automatic dependency installation
5051
- Git hooks (treefmt + mypy) auto-configured
@@ -66,7 +67,7 @@ uv add stackone-ai
6667
```bash
6768
# Install with dynamic discovery support (requires Python 3.10+)
6869
uv add 'stackone-ai[mcp]'
69-
# or
70+
# or
7071
pip install 'stackone-ai[mcp]'
7172

7273
# Install with CrewAI examples (requires Python 3.10+)
@@ -358,6 +359,7 @@ result = feedback_tool.call(
358359
```
359360

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

0 commit comments

Comments
 (0)