Skip to content

docs: 📝 Update MCP server docs for SDK v2 and the 2026-07-28 protocol - #1101

Merged
mistryrn merged 1 commit into
mainfrom
feat/admin_276-mcp-v2-docs-updates
Oct 6, 2026
Merged

mistryrn merged 1 commit into
mainfrom
feat/admin_276-mcp-v2-docs-updates

Conversation

@mistryrn

@mistryrn mistryrn commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Summary

Documentation updates to reflect the current state of the MCP Server (now running MCP SDK v2 and following the 2026-07-28 spec). Replaces LM Studio instructions with MCP TypeScript SDK's examples/cli-client to interact with our MCP Server using an LLM (as LM Studio isn't fully compliant with the 2026-07-28 spec) until our own MCP Client is ready. Also adds a setup-env script for quickstart of the MCP Server.

Issues

Description of Changes

Docs

  • Replaced the LM Studio instructions with the MCP TypeScript SDK's examples/cli-client run against Ollama, so that a chat can complete execute_query's confirmation
  • Stated what a client must support (2026-07-28 and elicitation) instead of naming hosts, so that readers can judge any client themselves
  • Added a changelog entry that LM Studio no longer works, so that users who followed the earlier docs know why
  • Removed the tech-debt entry for MCP_HOST never being bound, since feat: Upgrade apps/mcp-server to MCP SDK v2 and protocol revision 2026-07-28 #1099 fixed it, and marked the monorepo review's item 4 resolved instead of linking the removed entry

MCP Server

  • Added setup-env to the quick start and listed MCP_ALLOWED_HOSTS and MCP_REQUEST_STATE_SECRET as required on a non-loopback bind, so that a server started with the documented defaults does not exit at startup
  • Dropped SQON generation helpers from the README's not-implemented list, since build_sqon provides them

Integration Tests

  • Described the server instructions as coming from server/discover rather than initialize, in the docs and in the spin-up test's name

Special Instructions

N/A

Readiness Checklist

  • Self Review
    • I have performed a self review of code
    • I have run the application locally and manually tested the feature
    • I have checked all updates to correct typos and misspellings
  • Formatting
    • Code follows the project style guide
    • Automated code formatters (i.e. Prettier) have been run
  • Local Testing
    • Successfully built all packages locally
    • Successfully ran all test suites, all unit and integration tests pass
  • Updated Tests
    • Unit and integration tests have been added that describe the bug that was fixed or the features that were added
  • Documentation
    • All new environment variables added to .env.schema file and documented in the README
    • All changes to server HTTP endpoints have open-api documentation
    • All new functions exported from their module have TSDoc comment documentation

…ol revision

* Replaced the LM Studio instructions with the MCP TypeScript SDK's `examples/cli-client` run against Ollama, so that a chat can complete `execute_query`'s confirmation
* Stated what a client must support, `2026-07-28` and `elicitation`, instead of naming hosts, so that readers can judge any client themselves
* Added `setup-env` to the quick start and listed `MCP_ALLOWED_HOSTS` and `MCP_REQUEST_STATE_SECRET` as required on a non-loopback bind, so that a server started with the documented defaults does not exit at startup
* Described the server instructions as coming from `server/discover` rather than `initialize`, in the docs and in the spin-up test's name
* Added a changelog entry that LM Studio no longer works, so that users who followed the earlier docs know why
* Removed the tech-debt entry for `MCP_HOST` never being bound, since #1099 fixed it, and marked the monorepo review's item 4 resolved instead of linking the removed entry
* Dropped SQON generation helpers from the README's not-implemented list, since `build_sqon` provides them
@mistryrn
mistryrn merged commit 62c80fc into main Oct 6, 2026
2 checks passed
@mistryrn
mistryrn deleted the feat/admin_276-mcp-v2-docs-updates branch October 6, 2026 21:05
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