Skip to content

docs: Add documentation for eloquent-agents#3

Open
Lantum-Brendan wants to merge 2 commits into
whilesmartphp:mainfrom
Lantum-Brendan:docs/create-docs
Open

docs: Add documentation for eloquent-agents#3
Lantum-Brendan wants to merge 2 commits into
whilesmartphp:mainfrom
Lantum-Brendan:docs/create-docs

Conversation

@Lantum-Brendan

Copy link
Copy Markdown

Add docs.json manifest and 10 markdown files covering installation, quick start, harnesses, built-in tools, custom tools, security model, engine abstraction, MCP support, console commands, and prompts.

Add docs.json manifest and 10 markdown files covering installation,
quick start, harnesses, built-in tools, custom tools, security model,
engine abstraction, MCP support, console commands, and prompts.
@sourceant

sourceant Bot commented Jun 25, 2026

Copy link
Copy Markdown

Code Review Summary

The documentation for eloquent-agents is comprehensive, covering the entire lifecycle from installation to custom extensions. It provides clear examples for both configuration-driven and class-driven development.

🚀 Key Improvements

  • Clear explanation of the SDK-agnostic engine abstraction.
  • Detailed security section highlighting the importance of ToolContext and allowlisting.
  • Useful Artisan command reference for debugging tool registration.

💡 Minor Suggestions

  • Fix a namespace typo in the MCP documentation.
  • Clarify the expected format for JSON strings in tool parameters.

@sourceant sourceant Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review complete. No specific code suggestions were generated. See the overview comment for a summary.

Comment thread docs/installation.md Outdated
Comment on lines +31 to +32
# Groq
GROQ_API_KEY=

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looks like you have a typo here. Are you trying to reference GROK?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think that's how its spelt, Elon is a weird dude you know

@kofimokome

kofimokome commented Jul 3, 2026 via email

Copy link
Copy Markdown

@Lantum-Brendan

Copy link
Copy Markdown
Author

@kofimokome updated to use (xAI/Grok provider) per your review. The original used which is for Groq Inc., not xAI.
Source: Groq API uses at api.groq.com; xAI Grok uses at api.x.ai (https://docs.x.ai/developers/quickstart)

@sourceant sourceant Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review complete. See the overview comment for a summary.

Comment thread docs/built-in-tools.md
Comment on lines +56 to +57
- `id` (number, optional) - Record id, required for update.
- `values` (string) - JSON object of column-value pairs.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Clarify that the values parameter for eloquent.write should be a JSON-encoded string, as LLMs might try to pass a raw object depending on the engine implementation.

Suggested change
- `id` (number, optional) - Record id, required for update.
- `values` (string) - JSON object of column-value pairs.
- `values` (string) - JSON-encoded object of column-value pairs (e.g., '{"amount": 10}').

@kofimokome

Copy link
Copy Markdown

@kofimokome updated to use (xAI/Grok provider) per your review. The original used which is for Groq Inc., not xAI. Source: Groq API uses at api.groq.com; xAI Grok uses at api.x.ai (https://docs.x.ai/developers/quickstart)

I don't think you needed to change it. I was simply asking a question. Anyway, let @nfebe confirm whether he intended to use Groq or Grok.

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