Skip to content

Commit 1b01c01

Browse files
review feedback
1 parent 3380a80 commit 1b01c01

2 files changed

Lines changed: 34 additions & 63 deletions

File tree

ai/langchain-skills-agent/README.md

Lines changed: 34 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -97,39 +97,6 @@ langchain-skills-agent/
9797
curl -fsSL https://clis.cloud.ibm.com/install/linux | sh
9898
```
9999

100-
### Local Development
101-
102-
1. **Clone and setup**:
103-
```bash
104-
cd langchain-skills-agent
105-
cp .env.sample .env
106-
# Edit .env with your API credentials
107-
```
108-
109-
2. **Install dependencies**:
110-
```bash
111-
cd src
112-
pip install -e .
113-
# or with uv:
114-
uv sync
115-
```
116-
117-
3. **Run locally**:
118-
```bash
119-
python main.py
120-
```
121-
122-
4. **Test the agent**:
123-
```bash
124-
# Visit the landing page
125-
open http://localhost:8080
126-
127-
# Or use the API
128-
curl -X POST http://localhost:8080/runs \
129-
-H "Content-Type: application/json" \
130-
-d @payload/payload.json
131-
```
132-
133100
## ☁️ Deploy to IBM Cloud Code Engine
134101

135102
### Configuration
@@ -174,6 +141,39 @@ Remove all created resources:
174141
./deploy.sh clean
175142
```
176143

144+
### Local Development
145+
146+
1. **Clone and setup**:
147+
```bash
148+
cd langchain-skills-agent
149+
cp .env.sample .env
150+
# Edit .env with your API credentials
151+
```
152+
153+
2. **Install dependencies**:
154+
```bash
155+
cd src
156+
pip install -e .
157+
# or with uv:
158+
uv sync
159+
```
160+
161+
3. **Run locally**:
162+
```bash
163+
python main.py
164+
```
165+
166+
4. **Test the agent**:
167+
```bash
168+
# Visit the landing page
169+
open http://localhost:8080
170+
171+
# Or use the API
172+
curl -X POST http://localhost:8080/runs \
173+
-H "Content-Type: application/json" \
174+
-d @payload/payload.json
175+
```
176+
177177
## 🔌 API Endpoints
178178

179179
### `GET /`
@@ -301,40 +301,11 @@ The `skill_loader.py` module:
301301

302302
## 📚 Learn More
303303

304-
- [LangChain Documentation](https://python.langchain.com/)
305304
- [IBM Cloud Code Engine](https://cloud.ibm.com/docs/codeengine)
305+
- [LangChain Documentation](https://python.langchain.com/)
306306
- [IBM watsonx.ai](https://www.ibm.com/products/watsonx-ai)
307307
- [Agent Communication Protocol](https://github.com/IBM/agent-communication-protocol)
308308

309-
## 🤝 Contributing
310-
311-
To extend this agent:
312-
313-
1. Add new skills in `src/skills/`
314-
2. Follow the skill structure (metadata + implementation)
315-
3. Skills are automatically discovered
316-
4. Test locally before deploying
317-
318-
## 📝 License
319-
320-
This is a sample implementation for educational purposes.
321-
322-
## 🆘 Troubleshooting
323-
324-
### Skills not loading
325-
- Check that `skill.md` has valid YAML frontmatter
326-
- Ensure `__init__.py` exports the tool function
327-
- Verify the tool function name matches the directory name
328-
329-
### API errors
330-
- Verify your `.env` configuration
331-
- Check API key validity
332-
- Ensure the model name is correct for your provider
333-
334-
### Deployment issues
335-
- Confirm IBM Cloud CLI is installed and logged in
336-
- Check that Code Engine plugin is up to date
337-
- Verify resource group and region settings
338309

339310
---
340311

2.47 KB
Loading

0 commit comments

Comments
 (0)