Skip to content

Prompt Decorators

Welcome to the Prompt Decorators documentation! This framework provides a structured way to enhance prompts for Large Language Models (LLMs) through the application of modular, reusable "decorators."

Table of Contents

What is Prompt Decorators?

Prompt Decorators is a Python framework that allows you to apply various "decorators" to your prompts, each adding specific functionality or behavior. This approach makes prompt engineering more modular, reusable, and maintainable.

Key features include:

  • Modular Prompt Engineering: Apply specific prompt techniques independently
  • Decorator Registry: Discover and use decorators dynamically
  • Compatibility Checking: Ensure decorators work well together
  • Dynamic Implementation: Runtime loading of decorators from definitions
  • API Integration: Work with multiple LLM providers
  • MCP Integration: Integration with the Model Context Protocol

Quick Start

Installation

pip install prompt-decorators

Basic Usage

from prompt_decorators import apply_dynamic_decorators, create_decorator_instance

# Using inline decorator syntax
prompt = """
+++Reasoning(depth="comprehensive")
+++OutputFormat(format="markdown")
Explain quantum entanglement.
"""
decorated_prompt = apply_dynamic_decorators(prompt)

# Or using programmatic approach
reasoning = create_decorator_instance("Reasoning", depth="comprehensive")
output_format = create_decorator_instance("OutputFormat", format="markdown")

prompt = "Explain quantum entanglement."
decorated_prompt = output_format(reasoning(prompt))

# Use the decorated prompt with your favorite LLM API
# ...

Documentation

Guides

Project Information

  • Contributing - How to contribute to the project
  • Development - Setting up the development environment
  • FAQ - Frequently asked questions
  • Glossary - Definitions of key terms
  • Roadmap - Future development plans

Why Use Prompt Decorators?

Modularity

Each decorator focuses on a specific prompt engineering technique, allowing you to mix and match them as needed.

Reusability

Create a library of prompt techniques that can be reused across different projects and applications.

Standardization

Establish consistent prompt patterns across your organization or project.

Experimentation

Easily test different prompt engineering approaches by swapping decorators.

Compatibility

Work with multiple LLM providers using the same decorator patterns.

Getting Help

If you need help with Prompt Decorators, you can:

License

Prompt Decorators is released under the Apache 2.0 License. See the LICENSE file for details.