Features
Resources Documentation
Overview
The Resources section of the application allows you to store additional contextual information into the system. This information allows the AI Agent or LLM client to understand the context around their task better. Adding additional pieces of information like example, configuration structures, or even images allows the tool to use these items to its advantage.
To see more about what resources are and how best to rationalize them, take a look at the What are resources section.
Resources in Ctxpack
You can add two different types of resources into the Ctxpack platform:
- Textual resources
These are resources that can be represented in a textual format. Think items like example-template.md, user-list.csv, .env.example, api-doc.json or communication-standard-tone.txt.
- Binary resources
These can be images or other files that an LLM or AI Agent might want to use.
Image a context pack that has a use case to generate press releases or changelogs. For that pack, it is useful to have at least an example changelog format file, potentially the company logo. This can be combined with a tool that provides information about closed development tasks via an API call to Jira.
Getting Started
Creating your first resource
The "Resources/create" section allows users to add a new intelligence resource to the database. It provides fields for resource details, content, and templates.
The resource creation interface provides comprehensive tools for defining and configuring your resources. Begin by establishing the essential details that identify your resource. Create a descriptive URI following the pattern ctxpack://my-resource-category/resource-name. Pair this with a meaningful name and description that clearly communicate the resource's function and intended use.
When defining the actual resource content, you have flexibility in how you structure the information. You can input content directly into the interface or upload a file to the system. The system accommodates various content types through its MIME type selector, ensuring proper handling regardless of whether you're working with text, JSON, images, or other formats. Additionally, specifying the resource size in bytes helps with system optimization and performance management.
Best Practices
Name your resources correctly
Effective resource management starts with descriptive naming conventions that make resource contents immediately obvious from their URIs. Thoughtful grouping ensures related resources are bundled within the same context packs, guaranteeing they are available together when needed for complex tasks.