Repository navigation
Document the management API and CLI with real examples: Swagger, CLI README, CLI guide - #1528
Merged
Merged
Conversation
helpcodeai
force-pushed
the
docs/cli-readme-swagger-examples
branch
from
November 5, 2026 09:42
649a7ce to
c8c9bac
Compare
…, examples Move the Swagger setup to common/openapi.ts. The description now says what AnythingMCP is today and covers authentication with management keys and their scopes, a curl and amcp quick start, rate limits and errors. Use the real version instead of 0.1.0, declare every tag the controllers use (a spec fails on undeclared or unused tags), offer the X-API-Key scheme on key-capable routes, and add descriptions and request/response examples to the core adapters, connectors, MCP server, key, role, audit and user endpoints. No runtime behaviour changes.
Add a banner and a code-mode image (HTML sources in packages/cli/assets), npm badges, a contents list, and recipes with real commands and output: tool calls, jq and cron pipelines, a code_execute program that loops over Shopify orders and joins HubSpot, workspace bootstrap, OpenAPI import and audit queries. Keep the full command reference. Sharpen the npm description and keywords.
helpcodeai
force-pushed
the
docs/cli-readme-swagger-examples
branch
from
November 5, 2026 10:20
c8c9bac to
96547d7
Compare
helpcodeai
enabled auto-merge (squash)
November 5, 2026 10:20
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
The developer docs for the CLI and the management API showed few real examples, and the Swagger description dated from the first release.
Swagger (
/api/docs)packages/backend/src/common/openapi.ts. The description now says what AnythingMCP is today and covers:MCP/MANAGEMENT_READ/MANAGEMENT_ADMIN);curland the equivalentamcp apicommands;APP_VERSION) instead of0.1.0.AI/MCPtags are gone.@ApiSecurity('api-key'). Before, Swagger UI never offered theX-API-Keyheader on any operation.codeModevalues), MCP keys, roles, audit and users.operations.tsis regenerated. The only change is the shorter summary of the server activity route.CLI README (
packages/cli, also shown on npm)packages/cli/assets/, linked by absoluteraw.githubusercontent.com/.../main/URLs so npm can show them. They resolve once this is onmain.code_executeprogram that loops over Shopify order pages and joins HubSpot;Guide
content/guides/{en,de,it}/anythingmcp-cli.mdxMerge order
This overlaps with #1525 (CLI 0.1.3):
packages/cli/README.md,packages/cli/package.json,generated/operations.tsandconnectors.controller.ts. Merge #1525 first. I'll then rebase this branch, carry the 0.1.3 behaviour (--version, the new 401/403 messages, the[admin]tag semantics) into the rewritten README, and regenerateoperations.ts.Test plan
npm run buildinpackages/backend@apidevtools/swagger-parser--maxWorkers=4) on 32 related suites: 547 passed, including the newcommon/openapi.spec.tsnpm testinpackages/cli: 21 passed, 2 skipped;npm run build -w packages/clinode scripts/generate-cli-operations.mjs --check: up to date (204 operations)/api/docson Cloud after deploy. The Support and Cron tags only load on Cloud/Enterprise, so the local render couldn't show them.Deployment modes
Cloud and self-hosted get the same document. Self-hosted operators see the self-hosted base URL (
http://localhost:4000) in the description.