Skip to content

Conversation

@jsw324
Copy link
Contributor

@jsw324 jsw324 commented Jun 28, 2025

Add PromptLibrary for Simple Prompt Management

This PR introduces a new PromptLibrary class that provides comprehensive prompt management capabilities within the Agentuity SDK.

Features Added

  • Prompt Storage & Versioning: Create, store, and version prompt templates with automatic variable extraction
  • Template Compilation: Compile prompts with variables using {{variable}} syntax
  • CRUD Operations: Full create, read, update, and delete operations for prompts
  • Error Handling: Dedicated exceptions for common prompt management scenarios

Usage

The PromptLibrary is automatically available in your agent context:

# Create a prompt template
await context.prompts.create(
    name="greeting",
    template="Hello {{name}}, welcome to {{service}}!",
    description="A friendly greeting prompt"
)

# Compile prompt with variables
message = await context.prompts.compile(
    "greeting", 
    {"name": "Alice", "service": "Agentuity"}
)
# Returns: "Hello Alice, welcome to Agentuity!"

# Get prompt metadata
prompt_data = await context.prompts.get("greeting")

# List all versions
versions = await context.prompts.versions("greeting")

Integration

  • Added to AgentContext as context.prompts
  • Exported from main package for direct use
  • Built on existing KeyValueStore infrastructure
  • Includes comprehensive error handling and validation

This enables simple, version-controlled prompt management without external dependencies.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 28, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch AGENT-431

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

InvalidPromptNameError: If the prompt name is invalid.
PromptExistsError: If the prompt already exists and force=False.
"""
with self.tracer.start_as_current_span("prompts.create") as span:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets use the same pattern as the other services for the span name agentuity.keyvalue.get so this would be agentuity.prompt.create

we should also maybe create a unique uuid for each prompt so we can reference that in the spans and then we can use that to associate different prompts to sessions in the backend.

@jsw324
Copy link
Contributor Author

jsw324 commented Jul 31, 2025

closing in favor of #84

@jsw324 jsw324 closed this Jul 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants