Skip to content

Commit 1664a89

Browse files
committed
update readme
1 parent 56d6b65 commit 1664a89

File tree

1 file changed

+2
-7
lines changed

1 file changed

+2
-7
lines changed

README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ ______________________________________________________________________
3838

3939
For developers building AI tools that need collaborative awareness, `jupyter_ai_tools` provides a `collaborative_tool` decorator that automatically enables real-time collaboration features:
4040

41+
This decorator enables other users in the same Jupyter environment to see when your AI tool is actively working on shared notebooks, improving the collaborative experience.
42+
4143
```python
4244
from jupyter_ai_tools.utils import collaborative_tool
4345

@@ -56,15 +58,8 @@ async def my_notebook_tool(file_path: str, content: str):
5658
# - Global awareness system (all users can see Alice is active)
5759
# - Notebook-specific awareness (for .ipynb files)
5860
return f"Processed {file_path}"
59-
60-
# For tools without user context, simply omit the user parameter
61-
@collaborative_tool()
62-
async def my_tool_no_user(file_path: str):
63-
"""Tool without collaborative awareness"""
64-
return f"Processed {file_path}"
6561
```
6662

67-
This decorator enables other users in the same Jupyter environment to see when your AI tool is actively working on shared notebooks, improving the collaborative experience.
6863

6964
______________________________________________________________________
7065

0 commit comments

Comments
 (0)