Skip to content

docs: add Kosli MCP server integration page - #359

Merged
dangrondahl merged 6 commits into
mainfrom
docs/mcp-server-integration
Aug 13, 2026
Merged

docs: add Kosli MCP server integration page#359
dangrondahl merged 6 commits into
mainfrom
docs/mcp-server-integration

Conversation

@dangrondahl

@dangrondahl dangrondahl commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

What

Adds a documentation page for the Kosli MCP server, which exposes the Kosli API to AI assistants over the Model Context Protocol.

Changes

  • integrations/mcp_server.md (new) - install, configuration, how the three generic tools work, read-only example prompts, limitations.
  • config/navigation.json - added to the Integrations group.
  • understand_kosli/ai_docs_access.md - cross-link, so the docs MCP server and the API MCP server point at each other. One reads the documentation, the other reads your org's data.

Updated against v0.5.0

The preview page had drifted from the server:

  • Node floor raised from v20 to v22.
  • Added the beta warning and version-pinning guidance (npx -y @kosli/mcp-server@0.5.0).
  • Added a caution on execute_write_action - the client's approval prompt is the only checkpoint, and an assistant can select the wrong action, or the right action with the wrong parameters.
  • Fixed a broken link: the old page pointed at /getting_started/service-accounts, which does not exist. Now links /user/personal_api_keys for local use and /administration/authentication/service_accounts for automation.

Beta treatment

Uses tag: "BETA" in the front matter, matching the client_reference/ pages, plus an inline <Warning>.

Deliberately not reusing snippets/cli-beta-notice.mdx - it ends with "Please contact us to enable this feature for your organization", which is untrue here: the server is a public npm package with nothing to enable.

Verification

mint broken-links passes on everything touched here. It reports one pre-existing failure, left alone as out of scope:

tutorials/working_with_controls.mdx
 ⎿  /getting_started/service-accounts

That is the same bad path the old preview page carried. Happy to fix it in a follow-up.

@dangrondahl
dangrondahl requested a review from a team as a code owner August 11, 2026 15:46
@claude

claude Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Claude finished @dangrondahl's task in 1m 34s —— View job


Review of PR #359

  • Read CLAUDE.md and doc-review skill
  • Read changed files
  • Verify navigation.json entry — present ✓
  • Check for relative links — none found ✓
  • Check content conventions and writing style
  • Verify internal link targets exist — all resolve ✓
  • Post review findings

Summary

This is a well-structured how-to/reference page for the Kosli MCP server. The PR author has already addressed several rounds of review feedback across 6 commits — the tool-mechanics paragraph was trimmed, the KOSLI_ORG note was consolidated into the config table, and the missing period was fixed.

Navigation: integrations/mcp_server is correctly added to config/navigation.json.

Links: All five internal links resolve to existing pages. No relative links. The cross-link added to ai_docs_access.md is well placed and clearly distinguishes the two MCP servers.

Frontmatter: Title, description, and tag: "BETA" are all present and correct.

Diátaxis fit: The page mixes how-to (install tabs, config table) with reference (tools table, limitations) and a touch of explanation (how it works). This is appropriate for an integration page — splitting it would be over-engineering at this stage.

Findings

No critical or improvement-level issues. Two minor suggestions below.

Suggestionintegrations/mcp_server.md:29

These are the tool names your client shows as the assistant works, and the name in the prompt when it asks you to approve a write.

This sentence switches from plural ("names") to singular ("the name in the prompt") mid-sentence. Consider:

These are the tool names your client shows as the assistant works, and the names in the prompt when it asks you to approve a write.

Or drop the second clause — the write-action warning immediately below already covers the approval flow.

Suggestionintegrations/mcp_server.md:39

The third prerequisite ends without a period, unlike the two above it. (Edit: I see this was fixed in eba5640 — confirmed the current state on the branch has the period. ✓)

Overall assessment

The page is clear, accurate, and follows the project's conventions. The four install tabs cover the realistic client matrix well, the write-action warning is appropriately prominent, and the example prompts give readers something concrete to try. Good to go with or without the minor suggestion above.
·

@dangrondahl dangrondahl reopened this Aug 13, 2026
Comment thread integrations/mcp_server.md Outdated
Comment thread integrations/mcp_server.md Outdated
Comment thread integrations/mcp_server.md
Comment thread integrations/mcp_server.md Outdated
Comment thread integrations/mcp_server.md Outdated
Comment thread integrations/mcp_server.md
Comment thread integrations/mcp_server.md
Comment thread integrations/mcp_server.md
Comment thread integrations/mcp_server.md Outdated
Comment thread integrations/mcp_server.md
Comment thread integrations/mcp_server.md
@dangrondahl
dangrondahl merged commit 9c80dfe into main Aug 13, 2026
8 checks passed
@dangrondahl
dangrondahl deleted the docs/mcp-server-integration branch August 13, 2026 10:08
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.

2 participants