From aa4ece64c5dbeab1f6b881eae53048872bc02bc4 Mon Sep 17 00:00:00 2001 From: yubi_shi Date: Thu, 10 Sep 2026 09:44:50 +0800 Subject: [PATCH] docs: add Lensmor MCP setup guide --- README.md | 2 +- api-reference-backup/openapi.json | 2 +- api-reference/openapi.json | 2 +- changelog.mdx | 14 ++ docs.json | 11 + ...r-api-documentation-benchmark-checklist.md | 2 +- index.mdx | 2 +- llms-full.txt | 207 +++++++++++++++++- mcp/overview.mdx | 189 ++++++++++++++++ openapi.json | 2 +- scripts/test_sync_public_assets.py | 2 +- zh-Hans/index.mdx | 2 +- 12 files changed, 428 insertions(+), 9 deletions(-) create mode 100644 mcp/overview.mdx diff --git a/README.md b/README.md index 1c6e6bc..ddbdbb9 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ pnpm dlx mintlify dev ## Changelog -See `changelog.mdx` for versioned documentation updates. The current documentation version is `v0.26.0`. +See `changelog.mdx` for versioned documentation updates. The current documentation version is `v0.27.0`. --- diff --git a/api-reference-backup/openapi.json b/api-reference-backup/openapi.json index 1c70072..9e11e78 100644 --- a/api-reference-backup/openapi.json +++ b/api-reference-backup/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "Lensmor API", - "version": "0.26.0", + "version": "0.27.0", "description": "Lensmor Event Intelligence API for event discovery, exhibitor research, personnel lookup, credits, and profile matching.", "license": { "name": "Lensmor Terms of Service", diff --git a/api-reference/openapi.json b/api-reference/openapi.json index 1c70072..9e11e78 100644 --- a/api-reference/openapi.json +++ b/api-reference/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "Lensmor API", - "version": "0.26.0", + "version": "0.27.0", "description": "Lensmor Event Intelligence API for event discovery, exhibitor research, personnel lookup, credits, and profile matching.", "license": { "name": "Lensmor Terms of Service", diff --git a/changelog.mdx b/changelog.mdx index dd59a6b..f0588a4 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -5,6 +5,20 @@ description: "Versioned Lensmor API documentation updates, newly documented endp Track documentation updates, newly documented API capabilities, and behavior clarifications that may affect integrations. +## v0.27.0 + +Released September 10, 2026. + +### Added + +- Added the Lensmor MCP Server guide with the server URL, OAuth guidance, client-specific setup, example prompts, credit behavior, and troubleshooting. +- Added MCP as a top-level documentation tab. + +### Changed + +- Documented setup for Codex, ChatGPT, Claude Desktop, Claude Code, and other Streamable HTTP MCP clients. +- Updated OpenAPI metadata to version `0.27.0` and regenerated the machine-readable documentation resources. + ## v0.26.0 Released August 26, 2026. diff --git a/docs.json b/docs.json index 75b2430..07dcc75 100644 --- a/docs.json +++ b/docs.json @@ -140,6 +140,17 @@ ] } ] + }, + { + "tab": "MCP", + "groups": [ + { + "group": "Lensmor MCP", + "pages": [ + "mcp/overview" + ] + } + ] } ] }, diff --git a/docs/lensmor-api-documentation-benchmark-checklist.md b/docs/lensmor-api-documentation-benchmark-checklist.md index d030ead..53cac62 100644 --- a/docs/lensmor-api-documentation-benchmark-checklist.md +++ b/docs/lensmor-api-documentation-benchmark-checklist.md @@ -16,7 +16,7 @@ ## 2. 当前基线 -检查对象：`api-reference/openapi.json`，文档版本 `0.26.0`。 +检查对象：`api-reference/openapi.json`，文档版本 `0.27.0`。 | 指标 | 初始基线 | 完成全量 API Reference 优化后 | 判断 | | --- | ---: | ---: | --- | diff --git a/index.mdx b/index.mdx index 8145d05..0c8556b 100644 --- a/index.mdx +++ b/index.mdx @@ -7,7 +7,7 @@ Build event and attendee intelligence workflows with the Lensmor API. Use it to Use this documentation to authenticate, make your first request, and integrate Lensmor event, exhibitor, personnel, contact, and recommendation resources into your own workflows. -Current documentation version: `v0.26.0` +Current documentation version: `v0.27.0` ## Base URL `https://platform.lensmor.com` diff --git a/llms-full.txt b/llms-full.txt index 1567870..617c5ac 100644 --- a/llms-full.txt +++ b/llms-full.txt @@ -11,7 +11,7 @@ Build event and attendee intelligence workflows with the Lensmor API. Use it to Use this documentation to authenticate, make your first request, and integrate Lensmor event, exhibitor, personnel, contact, and recommendation resources into your own workflows. -Current documentation version: `v0.26.0` +Current documentation version: `v0.27.0` ## Base URL `https://platform.lensmor.com` @@ -209,6 +209,20 @@ Source: /changelog Track documentation updates, newly documented API capabilities, and behavior clarifications that may affect integrations. +## v0.27.0 + +Released September 10, 2026. + +### Added + +- Added the Lensmor MCP Server guide with the server URL, OAuth guidance, client-specific setup, example prompts, credit behavior, and troubleshooting. +- Added MCP as a top-level documentation tab. + +### Changed + +- Documented setup for Codex, ChatGPT, Claude Desktop, Claude Code, and other Streamable HTTP MCP clients. +- Updated OpenAPI metadata to version `0.27.0` and regenerated the machine-readable documentation resources. + ## v0.26.0 Released August 26, 2026. @@ -4994,6 +5008,197 @@ Use filters to narrow the returned event exhibitor rows. Apply the same recommen --- +## Lensmor MCP Server + +Source: /mcp/overview + +Connect your AI assistant to Lensmor. Search trade shows, research exhibitors, find relevant contacts, and request access to selected data without leaving the conversation. + + + `https://platform.lensmor.com/mcp` + + +## What is the Lensmor MCP Server? + +[Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is an open standard that lets AI assistants connect directly to external tools and data sources. + +The Lensmor MCP Server gives compatible AI clients live access to Lensmor event intelligence. Your assistant can search recorded trade shows, research exhibitors, discover relevant contacts, and help you complete data-access workflows using natural-language requests. + + + Lensmor MCP uses OAuth. A Lensmor Business API key is not a valid credential for the MCP endpoint. + + +## Why use it? + +Without an MCP connection, an AI assistant cannot query your current Lensmor data or use Lensmor actions. Once connected, it can work with the available data and operation schemas directly. + +| Without Lensmor MCP | With Lensmor MCP | +| --- | --- | +| Search event information manually | Ask the assistant to find events by topic, location, or date | +| Browse exhibitor directories page by page | Ask for exhibitors that match a product, technology, or use case | +| Filter contacts manually | Describe the companies and roles you want to find | +| Move between research and access screens | Request a quote and continue the approved workflow in the conversation | + +## Setup + + + + + + Open the profile menu in Codex and select **Settings**. + + + Under **Integrations**, select **Plugins**, then choose **Add → Add MCP server**. + + + Enter **Lensmor** as the name, select **Streamable HTTP**, and enter `https://platform.lensmor.com/mcp` as the URL. Leave the bearer-token environment variable and headers empty. + + + Select **Save**, complete Lensmor OAuth in the browser, and choose a Workspace when prompted. + + + + You can also add Lensmor from the Codex CLI: + + ```bash + codex mcp add lensmor --url https://platform.lensmor.com/mcp + codex mcp login lensmor + ``` + + + + + + In ChatGPT, open **Plugins**, select **+**, and create a new plugin. + + + Enter **Lensmor** as the name, choose **Server URL**, enter `https://platform.lensmor.com/mcp`, and select **OAuth** for authentication. + + + Review the custom MCP server notice, select the acknowledgement checkbox, and choose **Create**. Complete Lensmor OAuth in the browser and choose a Workspace when prompted. + + + + + Custom plugins must be enabled for your ChatGPT plan and Workspace. If the **+** button is unavailable, contact your Workspace administrator. + + + + + + + Open **Settings → Connectors**, select **Add custom connector**, and enter `https://platform.lensmor.com/mcp` as the Remote MCP server URL. + + + Save the connector, select **Connect**, and complete Lensmor OAuth. Choose a Workspace when prompted. + + + Restart the app before starting a new conversation so it can refresh the available Lensmor tools. + + + + + + Add Lensmor from your terminal: + + ```bash + claude mcp add --transport http lensmor https://platform.lensmor.com/mcp + ``` + + Run `/mcp`, select Lensmor, and complete OAuth. Start a new session after connecting. + + + + Add a **Streamable HTTP** server using: + + ```text + https://platform.lensmor.com/mcp + ``` + + Complete the Lensmor OAuth flow when your client prompts you to authenticate. + + + +### Tool permissions + +Your AI client may ask for approval before using a Lensmor tool for the first time. Use the client's permission settings to allow, prompt for, or block individual tools. + +Lensmor separately confirms operations that can consume credits. Connecting your account or allowing a tool does not approve a paid action. + +## Example prompts + +Once connected, describe the result you want as you would to a colleague. + +### Find relevant trade shows + +> “Find retail technology trade shows in Germany between March and June 2027.” + +### Research exhibitors + +> “At NRF 2027, find exhibitors offering computer-vision loss prevention and rank the best matches.” + +### Find contacts + +> “At CES 2027, find director-level procurement contacts at battery technology companies.” + +### Research a company + +> “Find marketing leaders at example.com and show the available contact summaries.” + +### Look up event history + +> “Which trade shows has Acme Robotics exhibited at since 2024? Show me the price before running the lookup.” + +### Request contact details + +> “Show me the price to unlock business emails for these five contacts.” + +## Credits and costs + +Most discovery and research operations are free to run. Directory access, reverse event lookups, and contact-detail unlocks can consume Lensmor credits. + +A paid workflow follows this sequence: + +```text +Select data → Review quote → Confirm → Receive result +``` + +- Creating a quote does not consume credits. +- The live quote shows the current price, chargeable items, available balance, and expiry. +- Only the signed-in user can approve the confirmation. +- Empty reverse-lookup results are not charged. +- Existing access and previously unlocked fields are taken into account before charging. + + + Prices and eligibility can vary by account, existing access, and product policy. Always use the live Lensmor quote as the final price before confirming. + + +## Troubleshooting + + + + Verify that the server URL is exactly `https://platform.lensmor.com/mcp`, without a trailing slash or extra path. Restart the client after adding the server. + + + + Complete Lensmor OAuth in the browser. Do not use a Business API key for this connection. If the authorization was revoked or the selected Workspace changed, disconnect Lensmor and authenticate again. + + + + Reconnect the server and start a new conversation so the client refreshes its available tools. Availability can also depend on your account and Workspace permissions. + + + + Choose the correct event, company, or person when the assistant asks. Lensmor does not automatically select an ambiguous result. + + + + Read the reason returned with the quote or result. The account may have insufficient credits, lack the required access, or be ineligible for that operation. + + + +--- + ## Error conventions Source: /concepts/errors diff --git a/mcp/overview.mdx b/mcp/overview.mdx new file mode 100644 index 0000000..a314213 --- /dev/null +++ b/mcp/overview.mdx @@ -0,0 +1,189 @@ +--- +title: "Lensmor MCP Server" +description: "Connect an MCP-compatible AI client to Lensmor for event discovery, exhibitor research, contact discovery, and confirmed data access." +--- + +Connect your AI assistant to Lensmor. Search trade shows, research exhibitors, find relevant contacts, and request access to selected data without leaving the conversation. + + + `https://platform.lensmor.com/mcp` + + +## What is the Lensmor MCP Server? + +[Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is an open standard that lets AI assistants connect directly to external tools and data sources. + +The Lensmor MCP Server gives compatible AI clients live access to Lensmor event intelligence. Your assistant can search recorded trade shows, research exhibitors, discover relevant contacts, and help you complete data-access workflows using natural-language requests. + + + Lensmor MCP uses OAuth. A Lensmor Business API key is not a valid credential for the MCP endpoint. + + +## Why use it? + +Without an MCP connection, an AI assistant cannot query your current Lensmor data or use Lensmor actions. Once connected, it can work with the available data and operation schemas directly. + +| Without Lensmor MCP | With Lensmor MCP | +| --- | --- | +| Search event information manually | Ask the assistant to find events by topic, location, or date | +| Browse exhibitor directories page by page | Ask for exhibitors that match a product, technology, or use case | +| Filter contacts manually | Describe the companies and roles you want to find | +| Move between research and access screens | Request a quote and continue the approved workflow in the conversation | + +## Setup + + + + + + Open the profile menu in Codex and select **Settings**. + + + Under **Integrations**, select **Plugins**, then choose **Add → Add MCP server**. + + + Enter **Lensmor** as the name, select **Streamable HTTP**, and enter `https://platform.lensmor.com/mcp` as the URL. Leave the bearer-token environment variable and headers empty. + + + Select **Save**, complete Lensmor OAuth in the browser, and choose a Workspace when prompted. + + + + You can also add Lensmor from the Codex CLI: + + ```bash + codex mcp add lensmor --url https://platform.lensmor.com/mcp + codex mcp login lensmor + ``` + + + + + + In ChatGPT, open **Plugins**, select **+**, and create a new plugin. + + + Enter **Lensmor** as the name, choose **Server URL**, enter `https://platform.lensmor.com/mcp`, and select **OAuth** for authentication. + + + Review the custom MCP server notice, select the acknowledgement checkbox, and choose **Create**. Complete Lensmor OAuth in the browser and choose a Workspace when prompted. + + + + + Custom plugins must be enabled for your ChatGPT plan and Workspace. If the **+** button is unavailable, contact your Workspace administrator. + + + + + + + Open **Settings → Connectors**, select **Add custom connector**, and enter `https://platform.lensmor.com/mcp` as the Remote MCP server URL. + + + Save the connector, select **Connect**, and complete Lensmor OAuth. Choose a Workspace when prompted. + + + Restart the app before starting a new conversation so it can refresh the available Lensmor tools. + + + + + + Add Lensmor from your terminal: + + ```bash + claude mcp add --transport http lensmor https://platform.lensmor.com/mcp + ``` + + Run `/mcp`, select Lensmor, and complete OAuth. Start a new session after connecting. + + + + Add a **Streamable HTTP** server using: + + ```text + https://platform.lensmor.com/mcp + ``` + + Complete the Lensmor OAuth flow when your client prompts you to authenticate. + + + +### Tool permissions + +Your AI client may ask for approval before using a Lensmor tool for the first time. Use the client's permission settings to allow, prompt for, or block individual tools. + +Lensmor separately confirms operations that can consume credits. Connecting your account or allowing a tool does not approve a paid action. + +## Example prompts + +Once connected, describe the result you want as you would to a colleague. + +### Find relevant trade shows + +> “Find retail technology trade shows in Germany between March and June 2027.” + +### Research exhibitors + +> “At NRF 2027, find exhibitors offering computer-vision loss prevention and rank the best matches.” + +### Find contacts + +> “At CES 2027, find director-level procurement contacts at battery technology companies.” + +### Research a company + +> “Find marketing leaders at example.com and show the available contact summaries.” + +### Look up event history + +> “Which trade shows has Acme Robotics exhibited at since 2024? Show me the price before running the lookup.” + +### Request contact details + +> “Show me the price to unlock business emails for these five contacts.” + +## Credits and costs + +Most discovery and research operations are free to run. Directory access, reverse event lookups, and contact-detail unlocks can consume Lensmor credits. + +A paid workflow follows this sequence: + +```text +Select data → Review quote → Confirm → Receive result +``` + +- Creating a quote does not consume credits. +- The live quote shows the current price, chargeable items, available balance, and expiry. +- Only the signed-in user can approve the confirmation. +- Empty reverse-lookup results are not charged. +- Existing access and previously unlocked fields are taken into account before charging. + + + Prices and eligibility can vary by account, existing access, and product policy. Always use the live Lensmor quote as the final price before confirming. + + +## Troubleshooting + + + + Verify that the server URL is exactly `https://platform.lensmor.com/mcp`, without a trailing slash or extra path. Restart the client after adding the server. + + + + Complete Lensmor OAuth in the browser. Do not use a Business API key for this connection. If the authorization was revoked or the selected Workspace changed, disconnect Lensmor and authenticate again. + + + + Reconnect the server and start a new conversation so the client refreshes its available tools. Availability can also depend on your account and Workspace permissions. + + + + Choose the correct event, company, or person when the assistant asks. Lensmor does not automatically select an ambiguous result. + + + + Read the reason returned with the quote or result. The account may have insufficient credits, lack the required access, or be ineligible for that operation. + + diff --git a/openapi.json b/openapi.json index 1c70072..9e11e78 100644 --- a/openapi.json +++ b/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "Lensmor API", - "version": "0.26.0", + "version": "0.27.0", "description": "Lensmor Event Intelligence API for event discovery, exhibitor research, personnel lookup, credits, and profile matching.", "license": { "name": "Lensmor Terms of Service", diff --git a/scripts/test_sync_public_assets.py b/scripts/test_sync_public_assets.py index d1e03c9..373843b 100644 --- a/scripts/test_sync_public_assets.py +++ b/scripts/test_sync_public_assets.py @@ -210,7 +210,7 @@ def iter_schema_properties(schema: object): def test_company_search_contract_matches_current_credit_rule(self) -> None: spec = json.loads(self.sync.OPENAPI_SOURCE.read_text(encoding="utf-8")) - self.assertEqual(spec["info"]["version"], "0.26.0") + self.assertEqual(spec["info"]["version"], "0.27.0") by_name = spec["paths"]["/external/personnel/events/by-name"]["get"] self.assertIn("up to 50 personnel records", by_name["description"]) diff --git a/zh-Hans/index.mdx b/zh-Hans/index.mdx index 01c24f3..7cf2faf 100644 --- a/zh-Hans/index.mdx +++ b/zh-Hans/index.mdx @@ -5,7 +5,7 @@ description: "使用 Lensmor API 构建展会与参会人员洞察、参展商 使用 Lensmor API 构建展会与参会人员洞察工作流。你可以发现展会、评估展会匹配度、查看参展商和参会人员来源，在数据可用时访问注册 Visitor，并在需要行动时解锁联系方式。 -当前文档版本：`v0.26.0` +当前文档版本：`v0.27.0` ## Base URL