Skip to content

docs: clarify usage, add pre-commit checks guidance and minor wording fixes #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeancsil merged 1 commit into from
Feb 17, 2026
Merged

docs: clarify usage, add pre-commit checks guidance and minor wording fixes #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions agentic-framework/AGENTS.md → AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This guide is for both external LLMs working within this codebase and developers

## Project Overview

This is an educational **LangChain + MCP framework** for building agentic systems in Python 3.12+.
This is a **LangChain + MCP framework** for building agentic systems in Python 3.12+.

### Key Technologies

Expand Down Expand Up @@ -114,7 +114,7 @@ External tool integration managed by `MCPProvider`.
- `web-fetch` - Web content fetching
- `tavily` - Web search

## Available Agents
## Example of Available Agents

### simple
Basic LLM assistant with no tools. Minimal example.
Expand Down Expand Up @@ -143,19 +143,21 @@ Codebase exploration agent with specialized local tools and webfetch MCP:
## Using Existing Agents

### CLI Usage
Use always with uv `uv --directory agentic-framework run agentic-run info developer`,
from the root of the git repository.

```bash
# List all available agents
agentic-run list
uv --directory agentic-framework run agentic-run list

# View detailed information about an agent
agentic-run info developer
uv --directory agentic-framework run agentic-run info developer

# Run an agent
agentic-run developer --input "Find all files with 'agent' in the name"
uv --directory agentic-framework run agentic-run developer --input "Find all files with 'agent' in the name"

# With timeout override
agentic-run travel --input "BCN to LIS next week" --timeout 120
uv --directory agentic-framework run agentic-run travel --input "BCN to LIS next week" --timeout 120
```

### Programmatic Usage
Expand Down Expand Up @@ -348,6 +350,15 @@ def test_my_agent_run(monkeypatch):
result = await agent.run("test")
assert "expected" in result
```
## Before committing

Before commiting, run `make check`, `make test` and if needed, `make format`. Fix them before committing.

make check runs:
- mypy - type checking
- ruff check - linting (no fixes)
- ruff format --check - formatting check (no fixes)


## Constants

Expand Down
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
AGENTS.md