deepset-ai
Fix: Update Agent's docstrings
Related Issues
- fixes #issue-number
Proposed Changes:
Updated Agent's docstrings as per Eliza's and Malte's suggestions to make the messaging consistent across communication channels.
How did you test it?
Notes for the reviewer
Checklist
- I have read the contributors guidelines and the code of conduct.
- I have updated the related issue with new insights and changes.
- I have added unit tests and updated the docstrings.
- I've used one of the conventional commit types for my PR title:
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes. - I have documented my code.
- I have added a release note file, following the contributors guidelines.
- I have run pre-commit hooks and fixed any issue.
The latest updates on your projects. Learn more about Vercel for GitHub.
| Project | Deployment | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| haystack-docs |  Ready |
Preview | Comment | Nov 13, 2025 9:52am |
![vercel[bot] avatar](https://avatars.githubusercontent.com/in/8329?v=4 "Published by a pub.dev verified publisher"){kind=small}
@agnieszka-m I'm also wondering if there is a way we could make the yaml part a more complete example. For example, this requires the core integration mcp-haystack to be installed to be usable which isn't indicated anywhere currently.
Pull Request Test Coverage Report for Build 19327416769
Details
- 0 of 0 changed or added relevant lines in 0 files are covered.
- 12 unchanged lines in 2 files lost coverage.
- Overall coverage decreased (-0.02%) to 91.42%
| Files with Coverage Reduction | New Missed Lines | % |
|---|---|---|
| core/pipeline/async_pipeline.py | 3 | 65.88% |
| components/agents/agent.py | 9 | 96.48% |
| <!-- | Total: | 12 |
| Totals | |
|---|---|
| Change from base Build 19326331064: | -0.02% |
| Covered Lines: | 13713 |
| Relevant Lines: | 15000 |
💛 - Coveralls
@sjrl to be honest, I just created an example that makes sense for the platform. I don't know much about haystack and what's needed to make it work there so if we want an example that works in haystack, I'd rely on someone from the haystack team to provide it.
I'd like this one to stay as is because it's shown in the Builder through docstrings as the component docs. I can add some lead-in sentence that this makes sense in the platform or something? not sure how to solve it for now. I guess the problem will be gone once we can build the docs with conditional filters by product.
@agnieszka-m feel free to update this PR with the changes we discussed offline!