Documentation Index
Fetch the complete documentation index at: https://docs.openlens.com/llms.txt
Use this file to discover all available pages before exploring further.
The MCP server registers ~40 tools scoped to the authenticated user’s projects. All require a valid OAuth session and operate with the same permissions as the web UI.
Project & client setup
| Tool | Description |
|---|
setup_client | Create a new OpenLens project with own brand, competitors, topics, custom prompt attributes, and generated prompts. |
list_projects | List the user’s OpenLens projects. |
update_project_settings | Update name, URL, location, languages, active platforms, or generated prompts. refresh_prompts tops-up or recreates prompts. |
delete_project | Archive one project. History is preserved. |
Brands
| Tool | Description |
|---|
list_brands | List the own brand and competitors tracked for a project. |
add_competitor | Add one competitor brand. |
delete_competitor | Delete one competitor brand. The own brand cannot be deleted this way. |
| Tool | Description |
|---|
list_platforms | List the AI platforms the user is entitled to. |
Topics
| Tool | Description |
|---|
list_topics | List tracked topics for a project. |
add_topic | Add one topic and start background prompt generation. |
delete_topic | Delete one topic and its prompts. Historical results cascade-delete. |
Prompts
| Tool | Description |
|---|
list_prompts | List active and inactive prompts, optionally scoped to one topic. |
add_prompt | Add one manual prompt. Attributes must come from list_prompt_attributes. |
set_prompt_active | Activate or deactivate without deleting historical results. |
update_prompt_template | Edit text and/or attributes. Clone-on-change protection. Returns requires_confirmation for prompts with history. |
delete_prompt | Delete one prompt. Use set_prompt_active for reversible deactivation. |
Prompt attributes
| Tool | Description |
|---|
list_prompt_attributes | Built-in + custom attributes for a project. |
add_prompt_attribute | Add one custom attribute. |
archive_prompt_attribute | Archive a custom attribute. Historical labels are preserved. |
unarchive_prompt_attribute | Restore an archived custom attribute. |
Prompt runs
| Tool | Description |
|---|
run_prompts | Start a run. Returns immediately. Poll get_run_status every ~30s until completed or failed. |
cancel_run | Cancel a running prompt run. Safe for already-terminal runs. |
get_run_status | Get status. Omit run_id for the latest run. |
list_runs | List recent runs (running, completed, failed, cancelled, interrupted). |
Visibility & analytics
| Tool | Description |
|---|
get_visibility | Brand visibility for the latest usable run. Supports overview, by_topic, by_platform. |
get_topic_visibility | Detailed visibility for one topic. |
get_trends | Multi-brand visibility trends over the last N days. |
get_prompt_results | Raw AI response text, with optional filters. |
get_prompt_performance | Rank prompts by appearance, coverage, position, citations, sentiment. |
get_attribute_breakdown | Per-attribute brand sentiment and evidence for one topic. |
get_engine_patterns | Compare how each platform sources and structures answers. |
get_citations | Top cited domains, with optional filters. |
get_mentions | Own-brand mention summaries grouped by topic. |
Workstreams
| Tool | Description |
|---|
list_workstreams | List goal-tracked workstreams. |
get_workstream | Header + 30-day sparkline + 90-day trend series. |
get_workstream_breakdown | Prompt-level movers and competitor share. |
manage_workstream | Create, update, archive, unarchive. |
update_workstream_goal | Append a new current goal. Past goals stay in history. |
Scheduling
| Tool | Description |
|---|
manage_schedule | Get or update the scheduled prompt-run settings. Call with no fields to inspect. |