Skip to content

docs: document missing MCP tools and parameters in Readme - #30

Open
param-gremlin wants to merge 1 commit into
gremlin:mainfrom
param-gremlin:docs/readme-tool-coverage
Open

docs: document missing MCP tools and parameters in Readme#30
param-gremlin wants to merge 1 commit into
gremlin:mainfrom
param-gremlin:docs/readme-tool-coverage

Conversation

@param-gremlin

Copy link
Copy Markdown

Brings Readme.md's tool documentation back in sync with the tools the server actually registers in src/.

Added

Tool Category Notes
list_teams New Teams section (top of Available Tools) No params. Entry point for discovering teamId, which nearly every other tool requires.
run_reliability_test Testing & Experiments Requires SERVICES_RUN privilege; can return HTTP 400 if a test is already running/scheduled for the service.
get_pending_test_runs Testing & Experiments Params: teamId, serviceId (both required). Useful for diagnosing the above 400.
search_gremlin_api New Direct API Access section Searches the Gremlin OpenAPI spec for endpoints.
execute_gremlin_api New Direct API Access section Executes an arbitrary Gremlin API endpoint. Endpoints requiring a *_RUN privilege prompt for interactive confirmation unless bypassed via confirmExecution. Can trigger real chaos experiments.

Also added two Overview bullets (test execution/queued run inspection, direct API access) and two Usage Notes bullets (list_teams for discovering team IDs; *_RUN privilege requirement for test-triggering operations).

Corrected

  • get_reliability_experiments was missing the includeScenarioRun (optional, default false) parameter.

Scope is limited to the Overview, Available Tools, and Usage Notes sections of Readme.md; no other files changed.

Everything above was verified directly against the tool registrations in src/ (not against a running server) — see src/tools/index.ts for the full registration list and the individual files under src/tools/ for each tool's schema.

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.

1 participant