Skip to content

Document agent integration, evaluation and provider setup - #1074

Open
zlareb1 wants to merge 16 commits into
mainfrom
docs/agent-answerability
Open

zlareb1 wants to merge 16 commits into
mainfrom
docs/agent-answerability

Conversation

@zlareb1

@zlareb1 zlareb1 commented Nov 20, 2026 •

Copy link
Copy Markdown
Member

Changelog category (leave one):

  • Documentation (changelog entry is not required)

Changelog entry

Not required for documentation.

Why

Agents need a direct path from integration and repository questions to valid requests, access outcomes and provider diagnostics. Canonical guides connect those workflows with explicit evaluation and release boundaries.

Scope and risk

Adds an agent-platform guide and links it from the documentation and generated agent indexes. Extends repository Q&A, linked-memory, evaluation and repository-access guides with concrete examples, observable outcomes and limitations. The proposed paired evaluation records actual tool use, objective task outcomes, total cost and latency without claiming a measured benefit. Customer delivery guidance distinguishes technical integration from support and commercial agreements.

Corrects operation descriptions at their source and regenerates the affected references and SDK comments. Uncached retrieval-only requests need both synthesize: false and no_cache: true. Repository listings can include permitted request-only metadata with readable: false; that metadata grants no code reads. Namespace authorization, indexed-source freshness and asynchronous memory-link boundaries remain explicit.

Adds a native-provider setup recipe, corrects embedding-provider selection and dimension descriptions, and makes proxy provider and model selection explicit. Dashboard guidance distinguishes displayed jobs from the conflict resolver's separate setting. The health checklist distinguishes configured fakes, passive process-local outcomes and actual inference, including compatible-embedding coverage limits.

Compatibility, rollout and rollback

  • Wire: no operation, field, setting or default changes. Retrieval, authorization and provider execution remain unchanged.
  • Operator steps: none for the documentation update. Recipes state credential, scope, worker-version and embedding-rebuild prerequisites.
  • Rollback: revert the documentation and generated descriptions and index row.

Tests

  • Focused documentation-link, public-copy and MCP listing-budget checks: 396 passed.
  • Pinned Markdown formatting, Python lint and formatting, prose, SDK/reference generator freshness, operation reach census and diff checks pass.
  • Six documented HTTP bodies, the stated retrieval-only flag combination and Python syntax passed local validation. The relevant input and base-class definitions match released implementation source.
  • The SDK constructor and direct operation interface were checked against the published wheel. Provider configuration and health contracts were checked against released source.
  • No live model calls or API writes were made by these checks. Account permissions, regional availability and useful answer quality were not exercised.
  • Fresh pushed-head technical and documentation reviews and full hosted CI are required.

AI assistance in the code (leave one; writing this description with AI is fine):

  • AI-generated: Codex wrote the documentation; operation contracts, SDK interfaces and provider behavior were checked against implementation source.

  • I can explain every line of this diff and how it interacts with the rest of Loom.

Checklist

  • make format-check, make lint, make typecheck and make test-unit pass; the integration suite passes if server behaviour changed.
  • Generated files are regenerated, not hand-edited.
  • No migration, plugin or frontend changes.
  • Documentation states prerequisites and no wire changes.
  • Examples use placeholders and public text contains no deployment-specific details.
  • Commits are signed off.

Connect canonical workflows with verified examples, access boundaries and a paired evaluation procedure so platform builders can find and check the answers.

Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
@vercel

vercel Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
loom-docs Ready Ready Preview Nov 21, 2026 1:21am UTC

Request Review

Document the existing cache and access metadata contracts in the API sources, generated references and agent examples.

Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
@zlareb1 zlareb1 changed the title Document agent platform integration and repository evaluation Document agent integration, evaluation and provider setup Nov 20, 2026
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Validate the guide together with current contribution and translation sources.

Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Check caller and run-history guidance with the agent integration documentation.

Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>

This branch has not been deployed

No deployments
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.

1 participant