Repository navigation
GML-2177 GML-2178 Improve HTTP mode and client documentation - #4
Merged
Merged
Conversation
- List both transports in the table of contents - Correct the tool count in the Copilot guide - Explain which URL scheme to use and why - Point the LangGraph guide at the single-session pattern Refs: GML-2177, GML-2178
- Cover configuration and profiles before the HTTP walkthrough that builds on them - Fold the header, profile and deployment reference into that walkthrough and drop the separate multi-user section - Describe serving several users in terms of what to configure Refs: GML-2177, GML-2178
- Build an agent from the loaded tools and run a question through it, inside the session so the tools stay bound to it Refs: GML-2177, GML-2178
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation only — no source changes.
Structure
The usage guide now introduces configuration and connection profiles before the HTTP
walkthrough that builds on them, and the separate "Multi-user Deployments" section is gone:
its header/profile reference, error semantics, and deployment notes are folded into the HTTP
section where they are used, and its duplicate editor snippet and design narrative removed.
Net −69 lines despite adding the walkthrough.
Both transports are now listed in the table of contents.
HTTP Mode End-to-End
A new five-step walkthrough — install, describe your sites, start the server, check it is
up, connect a client — including the responses a health check actually returns:
200400401502307/mcp/Every code was produced by running it against a live server.
Corrections
pip install tigergraph-mcpnow resolves MCP SDK 2.x, whose client API differs from 1.x in three ways: the function
name,
headersvshttp_client, and two return values instead of three. Working examplesare provided for both generations.
https://without explanation and omitted the trailingslash. The server serves plain HTTP and does not terminate TLS; the note now says when to
use which scheme.
question through an agent, inside the session so the binding holds.
get_tools(), whichstarts a subprocess per tool call.
Verification
All in-page anchors resolve (29 links, 0 broken), every
tigergraph__*name referenced acrossdocs/andexamples/exists (62 referenced, 0 missing), and the documented commands and bothclient snippets were run against a live TigerGraph 4.2.2 and both MCP SDK generations. 483 tests
pass.
Refs: GML-2177, GML-2178