Files
LangBot/skills/skills/langbot-testing/cases/langrag-kb-retrieve.yaml
T
Junyan Chin e9dd584792 feat: MCP server + in-repo skills (agent-friendly platform) (#2269)
* feat(api): support global API key from config.yaml (api.global_api_key)

Accept a config-defined global API key anywhere a web-UI key is accepted
(X-API-Key / Bearer), with no login session and no DB record. Useful for
automated deployments and AI agents (HTTP API + MCP). Defaults to empty
(disabled); does not require the lbk_ prefix.

- templates/config.yaml: add api.global_api_key with security notes
- service/apikey.py: verify_api_key checks global key first (constant-time)
- docs/API_KEY_AUTH.md: document the global key + security guidance
- tests: cover global-key match, prefix-free, fallback-to-db, disabled

* feat(mcp): expose LangBot management as an MCP server at /mcp

Add an MCP (Model Context Protocol) server so external AI agents can manage a
LangBot instance. Reuses the same API-key auth as the HTTP API (including the
config.yaml global API key).

- pkg/api/mcp/server.py: FastMCP server wrapping the service layer; 21 curated
  tools across system/bots/pipelines/models/knowledge/mcp-servers/skills
- pkg/api/mcp/mount.py: ASGI dispatcher fronting Quart; authenticates /mcp
  requests with an API key, runs the streamable-HTTP session manager lifespan
- controller/main.py: serve the wrapped ASGI app via hypercorn (was run_task)
- web: new 'MCP' tab in the API integration dialog showing endpoint, auth, and
  client config; i18n for 8 locales
- tests/manual/mcp_smoke.py: e2e check (401 unauth, list tools, call tools)

Tool surface is intentionally curated (not all ~25 route groups) to keep the
agent surface small, safe, and maintainable. Extend deliberately.

* feat(skills): add in-repo skills/ as the single source of truth

Migrate the agent skills + QA/e2e test harness from the (now archived)
langbot-app/langbot-skills repo into LangBot/skills/, and add four new skills.

Migrated:
- langbot-plugin-dev, langbot-testing (e2e), langbot-env-setup,
  langbot-skills-maintenance, langbot-eba-adapter-dev
- the bin/lbs CLI (src/, test/, scripts/, schemas/, qa-agent-docs/)

New:
- langbot-dev      core backend + web development
- langbot-deploy   Docker/K8s deployment + config.yaml + global API key
- langbot-mcp-ops  operating the LangBot MCP server (/mcp)
- langbot-space-ops operating the Space marketplace MCP server

- src/cli.ts repoRoot(): recognize the skills assets root (skills.index.json +
  bin/lbs) so the CLI works when nested inside the LangBot repo
- README.md: unified skill catalog; skills.index.json regenerated

Parity with source verified: bin/lbs validate + node test suite match the
source repo (only the uncommitted .lbpkg build-artifact fixture differs).

* docs(agents): document agent-facing surfaces + API/MCP/skills sync rule

* docs(readme): add 'Built for AI Agents' section across all locales

Highlight MCP server, in-repo skills (single source of truth), AGENTS.md
sync rule, and llms.txt. Cross-link LangBot Space MCP marketplace.

* style(mcp): fix ruff format + prettier lint in MCP server and API panel

* style(web): prettier format MCP i18n locale entries

* docs(skills): note MCP instance control in dev/testing skills

All development-guidance skills now point to the LangBot instance MCP
server (/mcp) and the Space marketplace MCP server, reusing API keys.
2026-06-20 15:14:47 +08:00

58 lines
2.1 KiB
YAML

id: langrag-kb-retrieve
title: "LangRAG knowledge base ingests and retrieves a sentinel document"
mode: agent-browser
area: knowledge
type: feature
priority: p1
risk: medium
ci_eligible: false
tags:
- langrag
- knowledge
- rag
skills:
- langbot-env-setup
- langbot-testing
env:
- LANGBOT_FRONTEND_URL
- LANGBOT_BACKEND_URL
automation: scripts/e2e/langrag-kb-retrieve.mjs
automation_env:
- LANGBOT_FRONTEND_URL
- LANGBOT_BACKEND_URL
- LANGBOT_BROWSER_PROFILE
- LANGBOT_CHROMIUM_EXECUTABLE
automation_env_any:
- LANGBOT_LOCAL_AGENT_RAG_KB_UUID|LANGBOT_RAG_KB_UUID
automation_expected_text: "azalea-cobalt-7421"
preconditions:
- "LangRAG is installed and initialized in the active LangBot instance."
- "A working embedding model is available, preferably chroma-all-MiniLM-L6-v2 for local repeatability."
- "LANGBOT_LOCAL_AGENT_RAG_KB_UUID points to a LangRAG knowledge base containing azalea-cobalt-7421."
steps:
- "Open LANGBOT_FRONTEND_URL."
- "Navigate to Knowledge."
- "Create a knowledge base with engine LangRAG."
- "Select a working embedding model, preferably local Chroma embedding model chroma-all-MiniLM-L6-v2."
- "Upload skills/langbot-testing/fixtures/rag/sentinel-doc.txt."
- "Wait until the document row status is Completed."
- "Open Retrieve Test and query: What is the local agent runner retrieval sentinel?"
checks:
- "UI: The knowledge base appears in the Knowledge sidebar."
- "UI: The uploaded document status becomes Completed."
- "UI: Retrieve Test shows the uploaded document content."
- "UI: Retrieve Test result contains azalea-cobalt-7421."
- "Console: No unexpected frontend errors appear during creation, upload, or retrieve."
evidence_required:
- ui
- screenshot
- console
- backend_log
diagnostics:
- "If no LangRAG engine is available, check /api/v1/knowledge/engines and install langbot-team/LangRAG."
- "If the embedding selector does not show a local Chroma model, confirm the model exists under embedding_models, not llm_models."
troubleshooting:
- marketplace-network-flaky
- dynamic-form-missing-config-id
- pipeline-form-controlled-warning