Updating #19
Updating #19
Conversation
WalkthroughThis update introduces new example environment files across multiple directories, standardizes Python version specifications, upgrades dependencies in both Python and JavaScript projects, and refines project configuration files. Numerous README files are enhanced with "Deploy with Agentuity" badges and improved formatting. Several YAML configuration files are updated for schema validation, metadata, and command arguments. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Agent
participant Agentuity Platform
User->>Agent: Provides .env.example with placeholder keys
Agent->>Agentuity Platform: Uses generated keys on import
Agentuity Platform-->>Agent: Supplies actual SDK/Project keys
User->>Agent: Follows README deploy badge to Agentuity
Agentuity Platform-->>User: Guides deployment process
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (3)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (2)
frameworks/crewai/researcher/pyproject.toml (1)
1-11: 🛠️ Refactor suggestionMissing
[build-system]sectionA PEP-518 compliant
pyproject.tomlneeds a[build-system]table specifyingbuild-backendandrequires. Without it, tools likepip install .may fail. Consider adding:[build-system] requires = ["hatchling"] build-backend = "hatchling.build"agentuity/sdk-py/basic-agent/README.md (1)
24-24:⚠️ Potential issueDirectory path typo needs fixing.
The instructions use
cd py-basic-agent, but the actual folder is namedbasic-agent. Please update both instances to:cd basic-agentAlso applies to: 43-43
♻️ Duplicate comments (4)
agentuity/sdk-js/vector-storage/.env.example (1)
1-3: Consistent placeholder formatting across examples.As with other SDK projects, update placeholders to angle-bracket notation (
<YOUR_SDK_KEY>,<YOUR_PROJECT_KEY>) and include a pointer to the doc or CLI steps for key provisioning. This ensures consistency and smoother onboarding.agentuity/sdk-js/agent-communication/.env.example (1)
1-3: Consistent placeholder formatting across examples.Align this file with others by using explicit placeholders (
AGENTUITY_SDK_KEY=<YOUR_SDK_KEY>) and adding a one-line note or link to docs on generating these keys during project import.agentuity/sdk-js/key-value-storage/.env.example (1)
1-3: Consistent placeholder formatting across examples.Use angle-bracket placeholders (
<YOUR_SDK_KEY>) and add a short instruction or documentation link for obtaining the SDK and project keys, matching the UX pattern across all.env.examplefiles.agentuity/sdk-py/vector-storage/.env.example (1)
1-3: Consistent placeholder formatting across examples.Consider switching to explicit placeholders (
AGENTUITY_PROJECT_KEY=<YOUR_PROJECT_KEY>) and referencing the relevant docs or commands for generating these variables, ensuring parity with other Python and JS SDK examples.
🧹 Nitpick comments (11)
frameworks/llamaindex/tool-calling/pyproject.toml (1)
4-4: Add a meaningful project description: Thedescriptionfield is empty. Including a concise description improves package metadata.Example:
description = "Tool-calling example using LlamaIndex with Agentuity"frameworks/crewai/basic/agentuity.yaml (1)
9-9: Standardize version quoting: Theversionfield now uses double quotes, whereas other configs use single quotes. Consider unifying style for consistency.-version: ">=0.0.131" +version: '>=0.0.131'frameworks/crewai/researcher/README.md (2)
31-33: Specify fenced code block languageThe environment variable snippet lacks a language marker. For proper syntax highlighting, change:
- ``` + ```env OPENAI_API_KEY=your_openai_api_key<details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 31-31: Fenced code blocks should have a language specified null (MD040, fenced-code-language) </details> </details> --- `70-72`: **Specify fenced code block language** The example usage snippet should declare a language (e.g., `text`) for clarity: ```diff - ``` + ```text Research and create a report on quantum computing<details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 72-72: Fenced code blocks should have a language specified null (MD040, fenced-code-language) </details> </details> </blockquote></details> <details> <summary>frameworks/mastra/workflow/.env.example (1)</summary><blockquote> `1-3`: **Improve placeholder clarity and usage instructions.** The `.env.example` correctly lists the required keys. For better developer experience, consider using explicit placeholder syntax (e.g., `AGENTUITY_SDK_KEY=<YOUR_SDK_KEY>`) and adding a brief comment or link to documentation on how to obtain or generate these values. Also verify that the actual `.env` file is ignored in `.gitignore` to prevent committing secrets. </blockquote></details> <details> <summary>agentuity/sdk-js/key-value-storage/src/agents/key-value-storage/index.ts (1)</summary><blockquote> `45-46`: **Inconsistent quoting in default error message.** Most literals use double quotes, but this error message uses single quotes to allow embedded double quotes. For uniformity, consider using a template literal: ```diff -return response.json({ - error: 'Invalid action. Use "get", "set", or "delete".', -}); +return response.json({ + error: `Invalid action. Use "get", "set", or "delete".`, +});frameworks/mastra/bird-checker/.env.example (1)
1-6: Introduce.env.examplewith environment variable placeholders
This file provides a clear template for settingAGENTUITY_SDK_KEY,AGENTUITY_PROJECT_KEY, andUNSPLASH_ACCESS_KEY. Consider adding explicit placeholder values (e.g.,<YOUR_SDK_KEY>) or brief usage instructions to guide users when they copy this to a.env.frameworks/mastra/workflow/README.md (1)
32-32: Consider spelling "multistep" as one word.YAML-style compound words like “multistep” are often written without a hyphen. You may update “multi-step workflow” to “multistep workflow” for consistency.
🧰 Tools
🪛 LanguageTool
[misspelling] ~32-~32: This word is normally spelled as one.
Context: ...he workflow demonstrates: - Creating a multi-step workflow with dependencies - Fetching a...(EN_COMPOUNDS_MULTI_STEP)
agentuity/sdk-js/agent-communication/agentuity.yaml (1)
8-9: Version field uses double quotes; consider unifying style.Currently
version: ">=0.0.0"is double-quoted, whereas other SDK configs use single quotes. For consistency, you could change toversion: '>=0.0.0'.frameworks/llamaindex/tool-calling/agentuity.yaml (2)
9-9: Inconsistent quoting for version
Here single quotes are used ('>=0.0.0'), whereas double quotes were used in other SDKs. Consider unifying the quoting style for consistency.
56-56: Ignore pattern quoting
Single quotes around**/__pycache__/**differ from double quotes elsewhere—consider standardizing.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (17)
agentuity/sdk-js/agent-communication/package-lock.jsonis excluded by!**/package-lock.jsonagentuity/sdk-js/key-value-storage/package-lock.jsonis excluded by!**/package-lock.jsonagentuity/sdk-js/streaming/bun.lockis excluded by!**/*.lockagentuity/sdk-js/telemetry/package-lock.jsonis excluded by!**/package-lock.jsonagentuity/sdk-js/vector-storage/package-lock.jsonis excluded by!**/package-lock.jsonagentuity/sdk-py/agent-communication/uv.lockis excluded by!**/*.lockframeworks/crewai/basic/uv.lockis excluded by!**/*.lockframeworks/crewai/researcher/uv.lockis excluded by!**/*.lockframeworks/langgraph/basic/bun.lockis excluded by!**/*.lockframeworks/llamaindex/tool-calling/uv.lockis excluded by!**/*.lockframeworks/mastra/basic/bun.lockis excluded by!**/*.lockframeworks/mastra/bird-checker/bun.lockis excluded by!**/*.lockframeworks/mastra/multi-step-workflow/package-lock.jsonis excluded by!**/package-lock.jsonframeworks/mastra/tool-calling/package-lock.jsonis excluded by!**/package-lock.jsonframeworks/mastra/workflow/package-lock.jsonis excluded by!**/package-lock.jsonframeworks/pydantic/basic/uv.lockis excluded by!**/*.lockframeworks/vercel/basic/bun.lockis excluded by!**/*.lock
📒 Files selected for processing (85)
.gitignore(1 hunks).python-version(1 hunks)agentuity/sdk-js/agent-communication/.env.example(1 hunks)agentuity/sdk-js/agent-communication/agentuity.yaml(2 hunks)agentuity/sdk-js/agent-communication/package.json(1 hunks)agentuity/sdk-js/agent-communication/src/agents/agent-communication/index.ts(2 hunks)agentuity/sdk-js/basic-agent/.env.example(1 hunks)agentuity/sdk-js/basic-agent/README.md(3 hunks)agentuity/sdk-js/basic-agent/agentuity.yaml(2 hunks)agentuity/sdk-js/key-value-storage/.env.example(1 hunks)agentuity/sdk-js/key-value-storage/README.md(5 hunks)agentuity/sdk-js/key-value-storage/agentuity.yaml(2 hunks)agentuity/sdk-js/key-value-storage/package.json(1 hunks)agentuity/sdk-js/key-value-storage/src/agents/key-value-storage/index.ts(2 hunks)agentuity/sdk-js/streaming/.env.example(1 hunks)agentuity/sdk-js/streaming/README.md(3 hunks)agentuity/sdk-js/streaming/agentuity.yaml(2 hunks)agentuity/sdk-js/streaming/package.json(1 hunks)agentuity/sdk-js/telemetry/.env.example(1 hunks)agentuity/sdk-js/telemetry/README.md(5 hunks)agentuity/sdk-js/telemetry/agentuity.yaml(2 hunks)agentuity/sdk-js/telemetry/package.json(1 hunks)agentuity/sdk-js/vector-storage/.env.example(1 hunks)agentuity/sdk-js/vector-storage/README.md(5 hunks)agentuity/sdk-js/vector-storage/agentuity.yaml(2 hunks)agentuity/sdk-js/vector-storage/package.json(1 hunks)agentuity/sdk-py/agent-communication/.env.example(1 hunks)agentuity/sdk-py/agent-communication/README.md(5 hunks)agentuity/sdk-py/agent-communication/agentuity.yaml(3 hunks)agentuity/sdk-py/basic-agent/.env.example(1 hunks)agentuity/sdk-py/basic-agent/README.md(3 hunks)agentuity/sdk-py/basic-agent/agentuity.yaml(3 hunks)agentuity/sdk-py/key-value-storage/.env.example(1 hunks)agentuity/sdk-py/key-value-storage/README.md(5 hunks)agentuity/sdk-py/key-value-storage/agentuity.yaml(3 hunks)agentuity/sdk-py/vector-storage/.env.example(1 hunks)agentuity/sdk-py/vector-storage/README.md(5 hunks)agentuity/sdk-py/vector-storage/agentuity.yaml(3 hunks)frameworks/crewai/basic/.env.example(1 hunks)frameworks/crewai/basic/.python-version(1 hunks)frameworks/crewai/basic/README.md(1 hunks)frameworks/crewai/basic/agentuity.yaml(2 hunks)frameworks/crewai/basic/pyproject.toml(1 hunks)frameworks/crewai/researcher/.env.example(1 hunks)frameworks/crewai/researcher/README.md(4 hunks)frameworks/crewai/researcher/agentuity.yaml(3 hunks)frameworks/crewai/researcher/pyproject.toml(1 hunks)frameworks/langchain/basic/.env.example(1 hunks)frameworks/langchain/basic/.python-version(1 hunks)frameworks/langchain/basic/README.md(1 hunks)frameworks/langchain/basic/agentuity.yaml(2 hunks)frameworks/langgraph/basic/.env.example(1 hunks)frameworks/langgraph/basic/README.md(1 hunks)frameworks/langgraph/basic/agentuity.yaml(2 hunks)frameworks/langgraph/basic/package.json(1 hunks)frameworks/llamaindex/basic/.env.example(1 hunks)frameworks/llamaindex/basic/.python-version(1 hunks)frameworks/llamaindex/basic/README.md(1 hunks)frameworks/llamaindex/basic/agentuity.yaml(2 hunks)frameworks/llamaindex/tool-calling/.env.example(1 hunks)frameworks/llamaindex/tool-calling/.gitignore(1 hunks)frameworks/llamaindex/tool-calling/README.md(5 hunks)frameworks/llamaindex/tool-calling/agentuity.yaml(3 hunks)frameworks/llamaindex/tool-calling/pyproject.toml(1 hunks)frameworks/mastra/basic/.env.example(1 hunks)frameworks/mastra/basic/README.md(1 hunks)frameworks/mastra/basic/agentuity.yaml(2 hunks)frameworks/mastra/basic/package.json(1 hunks)frameworks/mastra/bird-checker/.env.example(1 hunks)frameworks/mastra/bird-checker/README.md(4 hunks)frameworks/mastra/bird-checker/package.json(1 hunks)frameworks/mastra/multi-step-workflow/.env.example(1 hunks)frameworks/mastra/multi-step-workflow/README.md(3 hunks)frameworks/mastra/multi-step-workflow/package.json(1 hunks)frameworks/mastra/tool-calling/.env.example(1 hunks)frameworks/mastra/tool-calling/README.md(4 hunks)frameworks/mastra/tool-calling/package.json(2 hunks)frameworks/mastra/workflow/.env.example(1 hunks)frameworks/mastra/workflow/README.md(4 hunks)frameworks/mastra/workflow/package.json(2 hunks)frameworks/pydantic/basic/.env.example(1 hunks)frameworks/pydantic/basic/.python-version(1 hunks)frameworks/pydantic/basic/README.md(1 hunks)frameworks/vercel/basic/README.md(1 hunks)frameworks/vercel/basic/package.json(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
frameworks/crewai/researcher/README.md
31-31: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
72-72: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🪛 LanguageTool
frameworks/mastra/workflow/README.md
[misspelling] ~32-~32: This word is normally spelled as one.
Context: ...he workflow demonstrates: - Creating a multi-step workflow with dependencies - Fetching a...
(EN_COMPOUNDS_MULTI_STEP)
🔇 Additional comments (158)
frameworks/vercel/basic/README.md (1)
9-10: Badge added for one-click deployment
The "Deploy with Agentuity" badge is correctly inserted under the title, providing users with a quick link to deploy this example. This mirrors the badge placement in other framework READMEs and improves consistency.frameworks/vercel/basic/package.json (1)
24-24: Bump @agentuity/sdk to ^0.0.121
You've updated the SDK version to stay in sync with other examples. Please verify that this release exists on npm and review its changelog for any breaking changes before merging.agentuity/sdk-js/vector-storage/package.json (1)
28-28: Consistent SDK dependency version bump to ^0.0.121
The@agentuity/sdkdependency is aligned with other example packages in this PR, ensuring uniformity across the SDK ecosystem.frameworks/mastra/basic/package.json (1)
24-24: Aligned@agentuity/sdkversion across frameworks
Bumping to^0.0.121maintains consistency with the suite of framework and example projects updated in this PR.frameworks/langgraph/basic/package.json (1)
24-24: Update@agentuity/sdkto ^0.0.121 for consistency
This matches the coordinated SDK version upgrades applied throughout other framework packages in the PR..python-version (1)
1-1: Pin Python runtime to cpython-3.13.3-linux-x86_64-gnu
Introducing this.python-versionfile improves environment reproducibility by specifying the exact interpreter build.frameworks/pydantic/basic/.python-version (1)
1-1: Specify full patch-level Python version
Changing from3.12to3.12.0ensures consistent behavior and avoids unintended minor-version drift.frameworks/crewai/basic/.python-version (1)
1-1: Explicit patch version specified.Specifying “3.12.0” instead of “3.12” ensures consistent patch-level environment across developers and CI.
frameworks/langchain/basic/.python-version (1)
1-1: Explicit patch version specified.Aligns with other framework examples to pin to Python 3.12.0 and avoid ambiguity in patch releases.
frameworks/crewai/basic/.env.example (1)
1-3: Placeholder environment variables provided.Including
AGENTUITY_SDK_KEYandAGENTUITY_PROJECT_KEYwith an explanatory comment helps users bootstrap the example without exposing real credentials.frameworks/llamaindex/basic/.env.example (1)
1-3: Placeholder environment variables provided.Consistent with other frameworks’ templates, this
.env.exampleclearly documents required keys without exposing sensitive values.frameworks/pydantic/basic/.env.example (1)
1-3: Placeholder environment variables provided.Follows the established pattern for
.env.examplefiles, easing project setup while safeguarding credentials.frameworks/pydantic/basic/README.md (1)
9-9: Added "Deploy with Agentuity" badge
Inserts a deployment badge linked to Agentuity to improve documentation consistency and user guidance..gitignore (1)
35-39: Ignore Agentuity crash reports and env configs
The patterns.agentuity-crash-*.json,.env.development, and.env.productionare now excluded to prevent sensitive or environment-specific files from being committed.agentuity/sdk-js/agent-communication/src/agents/agent-communication/index.ts (2)
3-7: Added missingcontextparameter to handler signature
The handler function now accepts thecontextargument, which is correctly utilized for agent retrieval and broadcasting operations.
11-36: Standardized string literals and trailing commas
All string delimiters have been converted to double quotes and trailing commas have been added in object literals for stylistic consistency. No behavioral changes introduced.Also applies to: 38-57, 59-72, 74-77
frameworks/langchain/basic/agentuity.yaml (2)
11-15: Updated project metadata identifiers
Theproject_idwas refreshed to a new unique value, and thedescriptionfield was reformatted to an unquoted string style to align with other examples.
60-63: Refreshed agent identifiers
Agent IDs forConciergeandLocalGuidehave been updated to new values. Please verify these IDs against your actual agent definitions or dashboard entries.frameworks/langgraph/basic/agentuity.yaml (2)
11-15: Updated project metadata identifiers
Theproject_idwas updated and thedescriptionstring reformatted to unquoted style, consistent with other framework configurations.
71-74: Refreshed agent identifiers
The agent IDs have been updated to new unique values; ensure these correspond to the correct agents in your project or dashboard.frameworks/langgraph/basic/README.md (1)
9-9: Badge addition for quick deployment: The "Deploy with Agentuity" badge is a helpful addition to encourage users to deploy quickly via the Agentuity platform. The link and alt text look correct.frameworks/langgraph/basic/.env.example (1)
1-3: Provide placeholder environment variables: The.env.examplefile clearly indicates which environment variables are required and notes that they will be auto-generated. This aligns with other framework examples.frameworks/llamaindex/tool-calling/pyproject.toml (2)
3-3: Bump project version: Updating the version to0.1.0is appropriate for a new minor release following semantic versioning.
7-9: Verify dependency compatibility: Dependency bumps foragentuity,llama-index-core, andllama-index-llms-openaimay introduce breaking changes. Run the test suite and functional checks to confirm compatibility.Run:
pip install . && pytestframeworks/llamaindex/basic/agentuity.yaml (3)
11-11: Confirm new project ID: Ensure thatproj_4b73de52967b97ba22bb88f4bcffd3e9matches the intended Agentuity project configuration.
15-15: Unquoted description is valid: Removing quotes from the description maintains readability and YAML validity, since the string contains no special characters.
60-63: Confirm updated agent IDs: Theidfields for your agents have been refreshed (agent_ade29e3b68df8ca41f02c574b31647e0,agent_fac3a1f777e438d8a5f7929462017ef5). Verify these correspond to the correct agents in the Agentuity console.frameworks/crewai/basic/agentuity.yaml (5)
11-11: Confirm new project ID: Verify thatproj_86479fe4ccf357f65fb37c120f9e8f86matches the correct CrewAI project in the Agentuity console.
13-13: Update project name: Changing thenametocrewai-basic-test1is clear. Ensure it matches directory naming and documentation.
15-15: Unquoted description: Dropping quotes around the description is safe here and aligns with other examples.
56-56: Ignore pattern format: The bundler ignore pattern now uses double quotes; this is valid YAML. Make sure glob patterns are evaluated as intended.
60-60: Confirm updated agent ID: Theidfor theConciergeagent has been refreshed (agent_0df97a8cb97a209cde9783d02919866d). Verify this is correct in the Agentuity console.frameworks/crewai/basic/pyproject.toml (1)
7-9: Dependency version bumps look goodThe upgrades to
agentuity,crewai, andlangchain-anthropicversions align with the rest of the repository and ensure consistency across SDK examples.frameworks/crewai/basic/README.md (1)
9-10: Added "Deploy with Agentuity" badgeIncluding the deploy badge immediately below the title helps users quickly launch the example and matches the pattern applied in other READMEs.
frameworks/crewai/researcher/agentuity.yaml (7)
1-2: Schema reference for YAML validationAdding the
$schemadeclaration at the top enhances editor support and schema-based linting, ensuring the file remains valid as the spec evolves.
8-11: Updated version and project IDThe
versionsemver range andproject_idhave been updated to reflect the newly generated project metadata.
15-15: Clarified project descriptionThe
descriptionfield now clearly denotes this as a CrewAI framework example for the Python SDK.
25-33: Standardized development command touvSwitching dev to
uv run --env-file .env server.pyand updating watch paths toagents/**aligns with other Python examples using Uvicorn.
35-38: Aligned deployment command with developmentUsing
uv run server.pyfor deployment matches the development workflow and simplifies the runtime configuration.
50-56: Bundler configuration updated for UV runtimeChanging the bundler
identifiertopython-uv,runtimetouv, and adjusting ignore patterns ensures proper packaging of the new runtime environment.
60-60: Auto-generated agent ID refreshedThe
id: agent_b084b58842166822cd1748b3c8cd13c4corresponds to the latest scaffold and should be committed.frameworks/crewai/researcher/pyproject.toml (2)
2-5: Project metadata updatedThe
name,version,description, andrequires-pythonentries have been correctly adjusted to reflect the renamed project and refined Python version constraints.
7-9: Dependencies aligned with other examplesDependencies have been upgraded—
agentuityandcrewaibumped, andlangchain-openaireplaced bylangchain-anthropic—to stay consistent with the rest of the repo.frameworks/crewai/researcher/README.md (1)
3-4: Added "Deploy with Agentuity" badgeThe new badge provides an immediate link to deploy and maintains consistency with other example READMEs in this PR.
frameworks/crewai/researcher/.env.example (1)
1-3: Provide standardized environment template
The new.env.examplecorrectly lists required placeholders (AGENTUITY_SDK_KEY,AGENTUITY_PROJECT_KEY) and aligns with .gitignore updates to prevent leaking real keys.frameworks/mastra/basic/README.md (1)
9-9: Include “Deploy with Agentuity” badge
Adding the deploy badge under the main title enhances consistency across framework READMEs and makes deployment options more discoverable.frameworks/mastra/bird-checker/package.json (1)
29-29: Upgrade @agentuity/sdk dependency
Bumping the SDK from^0.0.73to^0.0.121brings this example in line with the latest release and other projects in the PR.agentuity/sdk-js/key-value-storage/package.json (1)
28-28: Sync SDK version with other JS examples
Updating@agentuity/sdkto^0.0.121ensures consistency and access to recent fixes/features.agentuity/sdk-js/agent-communication/package.json (1)
28-28: Align SDK version across packages
Bumping the dependency to^0.0.121matches the version used in sibling SDK examples.frameworks/langchain/basic/README.md (1)
9-10: Consistent "Deploy with Agentuity" badge added
The new badge follows the established pattern across examples, providing a quick link for deployment.frameworks/llamaindex/basic/.python-version (1)
1-1: Explicit patch version for Python
Specifying "3.12.0" rather than "3.12" clarifies environment requirements and aligns with other examples.agentuity/sdk-js/telemetry/package.json (1)
28-28: SDK dependency version bump
Upgrading@agentuity/sdkto "^0.0.121" ensures consistency with the rest of the JavaScript samples in this PR.frameworks/llamaindex/tool-calling/README.md (1)
3-4: Deployment badge addition consistent with other examples
The "Deploy with Agentuity" badge enhances visibility and standardizes documentation across frameworks.frameworks/llamaindex/basic/README.md (1)
9-10: Add "Deploy with Agentuity" badge
Badge placement under the heading matches the style applied across other framework READMEs.agentuity/sdk-js/telemetry/.env.example (1)
1-3: Approve placeholder environment template
The.env.examplecorrectly definesAGENTUITY_SDK_KEYandAGENTUITY_PROJECT_KEYwith an explanatory comment. This aligns with other SDK example projects and provides a clear starting point for users.frameworks/llamaindex/tool-calling/.env.example (1)
1-3: Approve placeholder environment template
The new.env.examplematches the repository-wide convention by definingAGENTUITY_SDK_KEYandAGENTUITY_PROJECT_KEYwith an explanatory note. This standardization aids onboarding across examples.frameworks/mastra/multi-step-workflow/.env.example (1)
1-3: Approve placeholder environment template
This.env.examplefollows the established pattern, providing clear placeholders forAGENTUITY_SDK_KEYandAGENTUITY_PROJECT_KEYalong with a helpful comment.frameworks/mastra/basic/.env.example (1)
1-3: Approve placeholder environment template
Consistent with other framework examples, this file clearly outlines the required environment variables without leaking sensitive data.frameworks/mastra/bird-checker/README.md (1)
3-4: Approve deployment badge enhancement
The added "Deploy with Agentuity" badge and extra spacing improve visual clarity and maintain consistency with other project READMEs.agentuity/sdk-js/streaming/.env.example (1)
1-3: ✅ Standardized environment template
The.env.examplecorrectly lists the two required placeholders with an explanatory comment that matches other SDK examples.
Ensure that your project’s root.gitignoreexcludes real.envfiles (e.g.,.env.development,.env.production) so no secrets are accidentally committed.frameworks/langchain/basic/.env.example (1)
1-3: ✅ Consistent.env.exampletemplate
This file aligns with the pattern used across all example repos. The placeholders and comment are clear for users to fill in.
Double-check that your.gitignoreincludes actual.envvariants to prevent leakage of real keys.agentuity/sdk-py/basic-agent/.env.example (1)
1-3: ✅ Python SDK example template
The placeholders and header comment are consistent with other.env.examplefiles. This will streamline onboarding for users.
Confirm that.envis ignored in version control to keep credentials safe.agentuity/sdk-js/basic-agent/.env.example (1)
1-3: ✅ JS SDK example environment template
Matches the established pattern for environment placeholders and comments. Users will appreciate the consistency across examples.
Verify your.gitignoreentries cover actual env files to avoid accidental commits.agentuity/sdk-py/agent-communication/.env.example (1)
1-3: ✅ Agent Communication Python example template
Well-formed placeholder file with a clear note on auto-generation. This keeps the onboarding flow uniform.
Make sure real.envfiles remain untracked in your repo’s root.gitignore.agentuity/sdk-py/key-value-storage/.env.example (1)
1-3: Placeholder environment variables added as expected.The
.env.exampleprovides the necessary keys (AGENTUITY_SDK_KEY,AGENTUITY_PROJECT_KEY) with explanatory comments, aligning with other SDK projects.frameworks/mastra/tool-calling/.env.example (1)
1-3: Consistent.env.exampletemplate.The placeholders and comment mirror other framework examples, offering users a clear starting point.
frameworks/mastra/multi-step-workflow/package.json (2)
11-11: Test script corrected.Replacing the escaped Unicode
\u0026\u0026with the standard&&improves readability and prevents shell interpretation issues.
29-29: Dependency version bumped.Updating
@agentuity/sdkto^0.0.121aligns with other Mastra packages in this PR.agentuity/sdk-py/basic-agent/README.md (1)
3-3: Deploy badge added.The "Deploy with Agentuity" badge enhances discoverability and consistency with other examples.
agentuity/sdk-js/key-value-storage/src/agents/key-value-storage/index.ts (4)
6-6: Addedcontexttype annotation.Importing and annotating
AgentContextenhances type safety for the KV operations.
11-13: Standardized string delimiters in "get" case.Switching from single to double quotes for both the case label and the response message aligns with the project's style conventions.
25-35: Standardized string delimiters in "set" case.All string literals (
"set","user-preferences", and the success message) now consistently use double quotes.
37-41: Standardized string delimiters in "delete" case.Switching to double quotes for the case label, key namespace, and success message maintains stylistic consistency.
agentuity/sdk-js/streaming/package.json (1)
26-26: Dependency version bump for@agentuity/sdk
The dependency has been updated to^0.0.121, aligning with other SDK example projects and tightening the semver range to patch-level changes.frameworks/mastra/multi-step-workflow/README.md (2)
3-3: Add 'Deploy with Agentuity' badge
Including the deploy badge at the top improves discoverability and brings consistency across all Agentuity examples.
6-6: Enhance readability with blank line insertions
Whitespace has been added around headings, list items, and code blocks to improve scanning and structure.Also applies to: 10-10, 13-13, 19-19, 31-31
agentuity/sdk-js/basic-agent/README.md (2)
3-3: Add 'Deploy with Agentuity' badge
Standardizing the deploy badge across examples helps with brand consistency and user onboarding.
6-6: Improve documentation readability with spacing
Additional blank lines around sections and code snippets make the guide easier to follow.Also applies to: 10-10, 12-12, 19-19
frameworks/mastra/tool-calling/package.json (3)
11-11: Fix test script chaining
Thetestscript now correctly uses&&instead of Unicode escapes (\u0026\u0026), ensuring it runs as expected in most shells.
13-20: Refactorkeywordsto multi-line for readability
Listing each keyword on its own line enhances maintainability and diff clarity when updating metadata.
29-29: Upgrade@agentuity/sdkdependency version
Bumped from^0.0.73to^0.0.121to stay in sync with other Mastra framework examples in this PR.agentuity/sdk-py/key-value-storage/README.md (2)
3-4: Addition of Deploy badge. Including the "Deploy with Agentuity" badge at the top is a great way to surface the one-click deploy option and keeps this example consistent with other SDK READMEs.
6-6: Spacing enhancements for readability. The inserted blank lines between headings, list items, and code blocks improve visual hierarchy and make the document easier to scan.Also applies to: 10-10, 14-14, 19-19, 29-29, 32-32, 58-58, 74-74, 78-78, 91-91
frameworks/mastra/workflow/package.json (3)
11-11: Fix test script chaining. Replacing\u0026\u0026with&&correctly restores shell chaining for the test script.
13-20: Formatkeywordsarray for readability. Breaking the keywords into a multi-line array enhances maintainability without altering functionality.
29-29: Upgrade@agentuity/sdkdependency. Bumping to^0.0.121aligns with other examples and ensures you receive the latest fixes and features.agentuity/sdk-py/agent-communication/README.md (2)
3-4: Addition of Deploy badge. The deployment badge at the top improves discoverability of the deploy command and matches other SDK example READMEs.
6-6: Spacing enhancements for readability. Consistent blank lines between sections, list items, and code blocks make the guide easier to follow.Also applies to: 10-10, 14-14, 19-19, 28-28, 54-54, 73-73, 87-87
frameworks/mastra/tool-calling/README.md (2)
3-4: Addition of Deploy badge. Including the "Deploy with Agentuity" badge improves consistency across framework examples and highlights the deploy workflow.
6-6: Spacing enhancements for readability. The blank lines inserted around headings and list items enhance the document’s structure and clarity.Also applies to: 10-10, 14-14, 32-32, 50-50
agentuity/sdk-js/telemetry/README.md (2)
3-4: Addition of Deploy badge. The "Deploy with Agentuity" badge aligns this JavaScript SDK example with others and emphasizes the quick-deploy capability.
6-6: Spacing enhancements for readability. Adding blank lines between sections and list items improves readability and maintains consistency with other telemetry and SDK examples.Also applies to: 10-10, 14-14, 30-30, 54-54, 69-69, 83-83
agentuity/sdk-js/vector-storage/README.md (1)
3-3: Add deployment badge to README: The "Deploy with Agentuity" badge is a great addition to facilitate quick deployments and align with other examples.agentuity/sdk-py/vector-storage/README.md (1)
3-3: Add deployment badge to Python README: The new "Deploy with Agentuity" badge aligns with other SDK examples and improves consistency.agentuity/sdk-js/key-value-storage/README.md (1)
3-3: Add deployment badge to key-value-storage README: Consistent badge addition enhances UX by providing a direct deployment link.agentuity/sdk-js/streaming/README.md (1)
3-3: Add deployment badge to streaming README: Aligns with other examples and improves readability.agentuity/sdk-js/streaming/agentuity.yaml (2)
9-13: Update project metadata: Theversion,project_id, andnamefields have been refreshed. Please verify that the new semver constraint ('>=0.0.89') matches the intended supported SDK versions and that theproject_idandnameare correct.
71-71: Refresh agent ID: Theagent.idvalue was updated. Ensure that this new identifier is propagated correctly in any referenced deployment scripts or documentation.agentuity/sdk-js/basic-agent/agentuity.yaml (5)
1-1: Add YAML schema reference for validation.Including the
$schemaat the top ensures IDEs and CI checks can validate this config against Agentuity’s schema.
8-9: Position and format the version semver range.The
version: '>=0.0.0'field is now correctly placed near the top with single-quoted semantics, matching other SDK examples.
11-11: Update project_id to unique generated identifier.This replaces the placeholder with a real, unique
proj_4f23f59773433d1d3c596f613f22656b.
15-15: Refine description formatting by removing quotes.The description is now an unquoted string, consistent with YAML best practices in other examples.
64-64: Update agent ID to new unique value.The agent’s
id: agent_bd832618d3c69b954e7b049f4c9bfb63has been regenerated.agentuity/sdk-js/vector-storage/agentuity.yaml (5)
1-1: Add YAML schema reference for validation.Enables schema-based linting/validation in editors and CI.
8-9: Standardize version field placement and formatting.Consistently moved near the top and formatted as
version: '>=0.0.0'.
11-11: Update project_id to generated unique identifier.Replaces placeholder with
proj_49bedd8dd9bcdcbdc2ebe454916d6321.
15-15: Refine description by removing quotes.Matches style used in other SDK
agentuity.yamlfiles.
64-64: Update agent ID to new generated value.Agent ID is now
agent_d445f51aff9ba0f448c7881c3116d8e6.frameworks/mastra/workflow/README.md (1)
3-3: Include "Deploy with Agentuity" badge.The badge at the top correctly links to the Agentuity deployment flow and matches other workflows.
agentuity/sdk-js/agent-communication/agentuity.yaml (4)
1-1: Add YAML schema reference for validation.Ensures this file is validated against the official Agentuity schema.
11-11: Update project_id to unique identifier.Now set to
proj_f78cf0f802b1a1c81cf40fb8b20ce20d.
15-15: Refine description by removing quotes.Matches the unquoted format used in other agentuity.yaml files.
64-64: Update agent ID to new generated value.Agent ID updated to
agent_1e40f954b873861e5312c141ef0595df.agentuity/sdk-js/telemetry/agentuity.yaml (5)
1-1: Add YAML schema reference for validation.This ensures proper linting and schema checks for the telemetry example.
8-9: Standardize version field placement and formatting.Now correctly placed near the top as
version: '>=0.0.0'.
11-11: Update project_id to new generated identifier.Replaced placeholder with
proj_8af8a36b0a4a89453aea85dd9b689961.
15-15: Refine description formatting by removing quotes.Matches other SDK YAML files.
64-64: Update agent ID to new generated value.Agent ID is now
agent_eb0abbc3274a159eda9a21f3bcaeafad.frameworks/mastra/basic/agentuity.yaml (4)
11-11: Project ID refreshed
Theproject_idhas been updated to the new Agentuity-generated identifier.
15-15: Description formatting updated
Thedescriptionfield is now unquoted and retains its original content.
71-71: Agent ID updated
The first agent’sidhas been refreshed to the new autogenerated value.
74-74: Agent list entry updated
The second agent’sidhas been refreshed to the new autogenerated value.agentuity/sdk-js/key-value-storage/agentuity.yaml (3)
1-1: Schema reference added
Inserted YAML schema annotation at the top for IDE/language-server validation.
8-15: Project metadata updated
Fieldsversion,project_id,name, anddescriptionhave been revised to match the new SDK example. Please verify that these values are synchronized in related artifacts (e.g.,package.json,README.md,.env.example).
64-64: Agent ID refreshed
The agent’sidhas been updated to a new autogenerated identifier.agentuity/sdk-py/vector-storage/agentuity.yaml (4)
13-13: Version string normalized
Standardized the semver requirement string format.
23-31: Development runtime switched to Uvicorn (uv)
Updatedwatch.filespath toagents/**and replaced thepythoncommand withuv run --env-file .env server.py. Ensure theuvalias (e.g., Uvicorn) is installed and documented for local development.
33-36: Deployment command updated
Switched the deployment runtime touv run server.pyfor consistency with the development setup.
48-54: Bundler configuration adjusted
Changedidentifiertopython-uv,runtimetouv, updatedagents.dirtoagents, and simplified ignore patterns to**/__pycache__/**. Please verify that the repository’s directory structure and bundler behavior align with these updates.agentuity/sdk-py/basic-agent/agentuity.yaml (4)
13-13: Version string normalized
Updated theversionfield to use a consistent double-quoted semver format.
23-31: Development runtime switched touv
Updatedwatch.filestoagents/**and replacedpythonwithuv run --env-file .env server.py. Ensure theuvCLI is available and aligns with other Python SDK examples.
33-36: Deployment command updated
Standardized deployment command touv run server.py.
48-54: Bundler and paths updated
Setidentifiertopython-uv,runtimetouv,agents.dirtoagents, and simplified ignore patterns. Confirm the agent directory relocation and ignore rules match your code layout.agentuity/sdk-py/key-value-storage/agentuity.yaml (4)
13-13: Version string normalized
Standardized theversionformat to a double-quoted semver requirement.
23-31: Development runtime switched
Changedwatch.filestoagents/**and replacedpythonwithuv run --env-file .env server.py. Verify that theuvalias is installed and that environment variables load correctly.
33-36: Deployment command updated
Switched touv run server.pyfor the deployment runtime.
48-54: Bundler config and paths updated
Updatedidentifiertopython-uv,runtimetouv,agents.dirtoagents, and simplified ignore patterns. Please verify directory structure and ignore settings.frameworks/llamaindex/tool-calling/.gitignore (1)
1-178: Comprehensive Python .gitignore
This template covers standard Python artifacts, build/distribution directories, caches, IDE/editor settings, environment files, and Agentuity crash logs. It aligns with other framework examples and will prevent accidental commits of generated or sensitive files.agentuity/sdk-py/agent-communication/agentuity.yaml (11)
1-1: Add YAML schema reference for validation
Including the$schemadirective enables IDEs and CI tools to validate this file against the official Agentuity schema.
9-9: Revisit the semver constraint
version: ">=0.0.0"is overly permissive. Confirm whether a higher minimum version (e.g.,>=0.1.0) is intended to avoid accidentally deploying unstable code.
11-11: Update autogenerated project ID
The newproject_idappears unique. Verify that downstream tools recognize it and that no references to the old ID remain.
15-15: Simplify description quoting
Removing surrounding quotes is safe here, as the string contains no special YAML characters.
25-25: Adjust watch paths
Switching watch patterns toagents/**aligns with the actual directory structure.
27-33: Standardize development command
Usinguv run --env-file .env server.pyensures environment variables load consistently and matches other SDK examples.
35-38: Standardize deployment command
Aligning with the development invocation,uv run server.pyprovides consistency and leverages the same runtime.
50-53: Update bundler settings
Changingidentifiertopython-uvandruntimetouvreflects the Uvicorn-based execution.
54-54: Correct agents directory
Settingbundler.agents.dirtoagentsmatches the local folder layout.
56-56: Focus ignore pattern
Only ignoring**/__pycache__/**ensures caches are omitted while not over-filtering other files.
60-60: Verify updated agent ID
Theagent.idhas changed—ensure this maps correctly to your registered agent and that any related metadata is updated.frameworks/llamaindex/tool-calling/agentuity.yaml (9)
1-1: Schema reference added
Including the$schemaimport helps with editor validation and error highlighting.
11-11: Autogenerated project ID updated
Newproject_idis in place—ensure no lingering references to the old ID exist.
15-15: Description reformatted
Unquoted description is fine since it contains no YAML-sensitive characters.
25-25: Watch path adjusted
Switching toagents/**correctly targets the folder where your code lives.
27-33: Align development command
Usinguv run --env-file .env server.pyis consistent with other examples and makes env loading explicit.
35-38: Align deployment command
Standardizing onuv run server.pysimplifies deployment scripts.
50-53: Bundler identifier/runtime updated
python-uvandruntime: uvreflect the Uvicorn-based execution environment.
54-54: Agents directory corrected
bundler.agents.dir: agentsnow matches the physical directory.
60-60: Agent ID refreshed
Confirm that the newagent.idcorresponds to the intended agent and update any dependent configuration accordingly.
Fixed missing agent from previous PR
Summary by CodeRabbit
New Features
Documentation
Chores
uv(likely Uvicorn) for development and deployment commands, updating related configuration accordingly.