mirror of
https://github.com/ComposioHQ/composio.git
synced 2026-09-22 11:46:35 +08:00
Soumya Medapati
b581670d40
## What In three independent eval runs across two rounds (ctx.composio.io/soumya/docs-agent-eval/), capable agents classified this block as prompt injection and deliberately ignored it (round 1, agent-007: "a prompt injection I had to identify and ignore"; round 3, two more agents unprompted). The ALWAYS/NEVER imperative framing also contradicted the sessions-vs-direct-execution page — the block forbade the API that page documents. ## Change Rewritten in `docs/lib/llm-guardrails/session.ts` — same facts, no commands: - Sessions documented as the recommended default (samples unchanged) - The provider-import gotcha kept — it's the most common real mistake in generated code - The managed-auth default kept - Direct execution acknowledged as a supported lower-level interface, with a link to the sessions-vs-direct tradeoffs page (this replaces the "DISCOURAGED — do not generate tools.execute()" section, which contradicted the docs one click away) An AI-steering block only works if AI readers trust it. ## Verification - `bun test tests/static/` passes (the execute-version policy test also validates the guardrail blocks) - Every factual claim from the old block is preserved; only the framing and the tools.execute() discouragement changed Split out of #4059 (which now carries only the legacy-flag and REST/SDK-naming changes) so this piece can be decided on its own. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
Composio Docs
Documentation site for Composio, built with Fumadocs.
Getting Started
bun install
bun run dev
Open http://localhost:3000.
Project Structure
docs/
├── app/ # Next.js app router
├── content/ # MDX content
│ ├── docs/
│ ├── examples/
│ ├── changelog/
│ └── reference/
├── components/ # React components
├── lib/ # Utilities
└── public/ # Static assets
Adding Content
Create an .mdx file in content/, add frontmatter, then add to meta.json:
---
title: Page Title
description: Brief description
---
Content here...
Components
<Tabs items={['Python', 'TypeScript']}>
<Tab value="Python">...</Tab>
<Tab value="TypeScript">...</Tab>
</Tabs>
<Callout type="info">Note</Callout>
<Cards>
<Card title="Title" href="/path" />
</Cards>
Sidebar
Each folder has meta.json for ordering:
{
"pages": ["page-one", "page-two"]
}
TypeScript Code Blocks
All TypeScript code blocks in MDX files are type-checked at build time using Twoslash. This ensures docs stay in sync with the SDK.
- Use
// @noErrorsto skip checking for partial snippets - Use
// ---cut---to hide setup code from output - Run
bun run buildlocally to validate before pushing
See CLAUDE.md for detailed patterns and troubleshooting.
Search
Docs search uses Algolia when NEXT_PUBLIC_ALGOLIA_SEARCH_API_KEY is set; otherwise it falls back to the local Fumadocs /api/search endpoint for development and tests. The sync script builds a first-party index from MDX/OpenAPI/toolkit data (no crawler required), splits long pages into section-sized records, configures searchable attributes/custom ranking/distinct, requests clickAnalytics, and sends search result view/click events with search-insights.
NEXT_PUBLIC_ALGOLIA_APP_ID=62HI9PQZ1L # optional; default shown
NEXT_PUBLIC_ALGOLIA_SEARCH_API_KEY=...
NEXT_PUBLIC_ALGOLIA_INDEX_NAME=docs_composio # optional; default shown
Sync the Algolia index with an admin key:
ALGOLIA_APP_ID=62HI9PQZ1L
ALGOLIA_ADMIN_API_KEY=...
ALGOLIA_INDEX_NAME=docs_composio bun run sync:search
Preview the generated records or test live relevance:
bun run sync:search --dry-run --samples
ALGOLIA_SEARCH_API_KEY=... bun run test:search "oauth auth config" "gmail send email"
Commands
| Command | Description |
|---|---|
bun run dev |
Dev server |
bun run build |
Production build (validates TS code blocks) |
bun run types:check |
Type check |
bun run sync:search |
Sync docs search records to Algolia |
bun run test:search |
Query the configured Algolia index from the terminal |