feat: add Proposal Document Generator agent - #635
Conversation
|
@unnati0605 is attempting to deploy a commit to the aditthyass' projects Team on Vercel. A member of the Team first needs to authorize it. |
|
Note
|
| Layer / File(s) | Summary |
|---|---|
Agent configuration src/agents/definitions/proposal-document-generator.js |
Defines the proposal generator’s metadata, provider/model settings, example inputs, required input schema, system prompt, and markdown output type. |
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~5 minutes
Possibly related PRs
- AditthyaSS/iloveAgents#495: Adds a similar new agent definition module with the same configuration pattern.
- AditthyaSS/iloveAgents#592: Also introduces an agent definition exporting metadata, inputs, and a prompt template.
- AditthyaSS/iloveAgents#625: Extends the same
src/agents/definitionspattern with another markdown-output generator.
Suggested labels
level:beginner, quality:clean, type:feature, gssoc:approved
Suggested reviewers
- AditthyaSS
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
| Check name | Status | Explanation |
|---|---|---|
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
| Linked Issues check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
| Title check | ✅ Passed | The title clearly and accurately summarizes the main change: adding a new Proposal Document Generator agent. |
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
✨ Finishing Touches
🧪 Generate unit tests (beta)
- Create PR with unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
|
Hey @unnati0605! 👋
|
|
hey @unnati0605! 👋 |
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/agents/definitions/proposal-document-generator.js (1)
57-71: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAsk for Markdown explicitly in the prompt.
outputType: "markdown"only changes rendering downstream; it does not make the model emit Markdown. A small prompt tweak here will make the output structure much more consistent inOutputRenderer.Suggested fix
- systemPrompt: `You are an expert sales proposal writer. - Given the client information,generate a professional proposal document. + systemPrompt: `You are an expert sales proposal writer. + Given the client information, generate a professional proposal document in Markdown. Include: Executive Summary Problem Statement Proposed Solution Scope of Work Pricing details Timeline Expected Outcomes Next Steps - Keep the proposal professional,convincing and concise.`, + Use Markdown headings for each section and bullet lists where helpful. + Keep the proposal professional, convincing, and concise.`,🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/agents/definitions/proposal-document-generator.js` around lines 57 - 71, The proposal generator prompt in proposalDocumentGenerator should explicitly instruct the model to produce Markdown, since outputType only affects rendering and not generation. Update the systemPrompt used by the proposal document generator to request a Markdown-formatted proposal (and keep the existing section list), so the output is consistently consumable by OutputRenderer.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/agents/definitions/proposal-document-generator.js`:
- Around line 5-6: Update the user-facing description in
proposal-document-generator so it reads cleanly in the agent picker: fix the
missing spaces after commas and correct the “free lancing” wording. Use the
description field in the proposal document generator definition as the target,
and keep the copy polished and professional.
---
Nitpick comments:
In `@src/agents/definitions/proposal-document-generator.js`:
- Around line 57-71: The proposal generator prompt in proposalDocumentGenerator
should explicitly instruct the model to produce Markdown, since outputType only
affects rendering and not generation. Update the systemPrompt used by the
proposal document generator to request a Markdown-formatted proposal (and keep
the existing section list), so the output is consistently consumable by
OutputRenderer.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 90383982-a7d7-4db1-acca-9ef94199572a
📒 Files selected for processing (1)
src/agents/definitions/proposal-document-generator.js
| description: | ||
| "Generate professional proposal documents for projects,free lancing, businesses,research and grants", |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the user-facing description copy.
This string will read unpolished in the agent picker because of the missing spaces and the free lancing typo.
Suggested fix
description:
- "Generate professional proposal documents for projects,free lancing, businesses,research and grants",
+ "Generate professional proposal documents for projects, freelancing, businesses, research, and grants",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| description: | |
| "Generate professional proposal documents for projects,free lancing, businesses,research and grants", | |
| description: | |
| "Generate professional proposal documents for projects, freelancing, businesses, research, and grants", |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/agents/definitions/proposal-document-generator.js` around lines 5 - 6,
Update the user-facing description in proposal-document-generator so it reads
cleanly in the agent picker: fix the missing spaces after commas and correct the
“free lancing” wording. Use the description field in the proposal document
generator definition as the target, and keep the copy polished and professional.
|
|
|
Hi @AditthyaSS, I have resolved the merge conflict and synced the branch with the latest main. Please let me know if further changes are required. Thank you!! |
|
Hi @AditthyaSS !! Kindly review this |
1 participant
What does this PR do?
Adds a new AI agent called Proposal Document Generator which generates professional sales related proposal documents based on client requirements, pricing, proposed solution and project timeline.
Closes #75
Type of change
Checklist
npm run buildlocally and it passed ✅import agents from '../agents/registry'✅Screenshots (if UI change)
No
Summary by CodeRabbit