-
-
Notifications
You must be signed in to change notification settings - Fork 26.5k
Adding the system prompt of Lightfield CRM #298
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.
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
base: main
Are you sure you want to change the base?
Conversation
Added detailed system prompt for Lightfield AI Agent, outlining data, security, response, and writing guidelines, as well as internal operation instructions.
Added detailed guidelines for the AI agent's operation, including data, security, response, and writing guidelines.
WalkthroughAdds a new comprehensive system prompt document "Lightfield CRM System Prompt" defining CRM domain models, response and planning workflows, a 24-tool catalog with parameters, data/security rules, entity-linking syntax, and operational constraints; updates README to list the new file. (46 words) Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (2)
Lightfield CRM/System Prompt.txt (2)
20-26: Reduce repetitive sentence beginnings in Thinking and Planning Guidelines.Three successive sentences (lines 21–23, and partially line 25–26) begin with "Determine," which reduces readability and flow. Consider rewording some sentences to vary structure:
- # Thinking and Planning Guidelines - Determine which accounts and other entities you need to retrieve the information from. - Consider checking additional accounts and entities since the table snapshots are potentially incomplete or outdated. - Determine which additional information you need to retrieve from the accounts and other entities. - Determine which arguments you will provide to the tools. - Determine how you will use the tool responses to answer the user's question. + # Thinking and Planning Guidelines + Identify which accounts and other entities you need to retrieve the information from. + Consider checking additional accounts and entities since the table snapshots are potentially incomplete or outdated. + Plan which additional information you need to retrieve from the accounts and other entities. + Prepare which arguments you will provide to the tools. + Determine how you will use the tool responses to answer the user's question.
28-34: Fix minor style inconsistencies flagged by static analysis.Three style issues should be corrected for consistency and clarity:
- Line 29, 34: "markdown" → "Markdown" (proper noun for the markup language)
- Line 32: Use consistent spelling: "judgement" → "judgment" (to align with American English conventions and the general tone of the document)
- # Writing Guidelines - Compose your response with short, precise, and smoothly flowing sentences. Use markdown tables when appropriate. + # Writing Guidelines + Compose your response with short, precise, and smoothly flowing sentences. Use Markdown tables when appropriate. The answer should be factual; avoid any speculations, opinions, commentary or predictions unless explicitly asked for. Do not include judgments, speculations and predictions unless explicitly asked. - If asked about judgement (e.g., how did the meeting go), or prediction (are they likely to buy) stick to facts and ground your answer in observations. + If asked about judgment (e.g., how did the meeting go), or prediction (are they likely to buy) stick to facts and ground your answer in observations. Avoid long responses. - Use markdown formatting sparingly to improve readability. + Use Markdown formatting sparingly to improve readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
Lightfield CRM/System Prompt.txt(1 hunks)README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
Lightfield CRM/System Prompt.txt
[style] ~25-~25: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uments you will provide to the tools. - Determine how you will use the tool responses to ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~29-~29: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...se, and smoothly flowing sentences. Use markdown tables when appropriate. - The answer s...
(MARKDOWN_NNP)
[uncategorized] ~32-~32: Do not mix variants of the same word (‘judgement’ and ‘judgment’) within a single text.
Context: ...less explicitly asked. - If asked about judgement (e.g., how did the meeting go), or pred...
(EN_WORD_COHERENCY)
[uncategorized] ~34-~34: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...rvations. - Avoid long responses. - Use markdown formatting sparingly to improve readabi...
(MARKDOWN_NNP)
🔇 Additional comments (3)
README.md (1)
96-96: Straightforward documentation addition.The README entry is properly formatted, correctly positioned alphabetically, and follows the existing conventions. ✓
Lightfield CRM/System Prompt.txt (2)
40-43: Entity linking syntax is well-designed; verify tool support.The special Markdown link syntax for CRM entities (
[displayName](#entityType:entityId)) is clearly documented with examples. This is good UX guidance. Ensure that downstream systems (UI/frontend) recognize and render these entity links correctly to make the feature effective.
45-51: Strong internal operation guidelines; one clarification note.Lines 45–51 provide clear, defensive guidance against common assistant pitfalls (e.g., not guessing data, not re-creating failed items, not calling tools when context is already provided). This is well-reasoned.
One observation: Line 51 specifically calls out the
askAccountQuestionArraytool and its limitations. This is good defensive guidance, but confirm that this tool's behavior and limitations are well-understood by the development team to avoid misuse.
Updated user information placeholders in the system prompt.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
Lightfield CRM/System Prompt.txt (2)
20-26: Reduce repetitive phrasing in thinking guidelines (optional style improvement).Lines 21, 23, and 25 all begin with "Determine," which is slightly repetitive. Consider varying the sentence structure for better readability—e.g., use "Identify," "Assess," or "Plan" as alternatives in a few of these bullets.
28-34: Fix capitalization of "Markdown" and standardize judgment/judgement spelling.Apply this diff to correct three minor language issues:
- Compose your response with short, precise, and smoothly flowing sentences. Use markdown tables when appropriate. + Compose your response with short, precise, and smoothly flowing sentences. Use Markdown tables when appropriate. - If asked about judgement (e.g., how did the meeting go), or prediction (are they likely to buy) stick to facts and ground your answer in observations. + If asked about judgment (e.g., how did the meeting go), or prediction (are they likely to buy) stick to facts and ground your answer in observations. - Use markdown formatting sparingly to improve readability. + Use Markdown formatting sparingly to improve readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
Lightfield CRM/System Prompt.txt(1 hunks)
🧰 Additional context used
🪛 LanguageTool
Lightfield CRM/System Prompt.txt
[style] ~25-~25: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uments you will provide to the tools. - Determine how you will use the tool responses to ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~29-~29: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...se, and smoothly flowing sentences. Use markdown tables when appropriate. - The answer s...
(MARKDOWN_NNP)
[uncategorized] ~32-~32: Do not mix variants of the same word (‘judgement’ and ‘judgment’) within a single text.
Context: ...less explicitly asked. - If asked about judgement (e.g., how did the meeting go), or pred...
(EN_WORD_COHERENCY)
[uncategorized] ~34-~34: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...rvations. - Avoid long responses. - Use markdown formatting sparingly to improve readabi...
(MARKDOWN_NNP)
🔇 Additional comments (3)
Lightfield CRM/System Prompt.txt (3)
54-60: ✅ PII remediation confirmed: placeholders replace hardcoded personal data.The previous review flagged hardcoded user information (
james ruc,personifycloud@gmail.com, user ID). This has been properly replaced with template placeholders (_____,________), confirming this is a deployment template that operators will customize. The security concern has been resolved.
1-52: System prompt structure and guidelines are comprehensive and well-designed.The guidelines effectively cover:
- Data integrity: Emphasis on verified information only (line 4)
- Security posture: Clear restrictions on disclosure of internal implementation (lines 6–9)
- CRM domain model: Clear Account/Opportunity/Contact relationships for B2B sales context (lines 12–15)
- Response strategy: Supports iterative retrieval and clarifying questions (line 18)
- Operational safety: Important context-aware safeguards (e.g., line 51 avoids redundant tool calls when context is already available)
The document establishes appropriate constraints for responsible AI agent behavior in a CRM environment.
63-138: Tool catalog is well-documented with clear parameter definitions.The 24-tool inventory provides comprehensive coverage of CRM operations (query, create, update, utilities) with consistent parameter documentation. No ambiguities or gaps detected.
Adding the system prompt of Lightfield crm
Summary by CodeRabbit
Documentation
Chores