Use the fastmoss command to discover and call FastMoss tools.
Startup checks
-
Check the CLI is available:
fastmoss --versionIf the FastMoss CLI is not installed or the command is not found, install it first:
npm install -g @fastmoss/cliTo update an existing FastMoss CLI installation to the latest package version, run:
npm install -g @fastmoss/cli@latest
Then continue to the login check.
-
Check login status:
fastmoss whoami -
If not logged in, ask the user to provide or configure an API key:
fastmoss login --api-key <your-api-key>
Tool workflow
-
Read
references/tool-call.mdbefore invoking a tool. -
Read
references/tools.mdto choose the tool and understand its parameters. -
Every
fastmoss callMUST include agent client metadata. Prefer environment variables when making one or more calls in the same shell session:FASTMOSS_CLIENT_NAME="<client-name>" FASTMOSS_CLIENT_VERSION="<client-version>" fastmoss call --tool <tool_name> --args '<json>' --output mcpOr pass explicit flags for a single call:
fastmoss call --client-name "<client-name>" --client-version "<client-version>" --tool <tool_name> --args '<json>' --output mcpUse the actual client name and version when available. Do not invent a version number; if the runtime does not expose a version, use the client name and omit the version only if the CLI allows it.
Prefer --output mcp when an LLM or agent will read and reason over the tool response. Use --output data when the user needs a concise end-user payload. Use --output rpc only when debugging raw RPC responses.
If the analysis result needs FastMoss detail-page links, call fastmoss_detail_url_examples first to get the link assembly rules, then build links from the returned examples and IDs in the analysis result.
References
references/cli.md: CLI command reference.references/tool-call.md: safe calling patterns, quoting, output modes, and error handling.references/tools.md: static FastMoss tool catalog index. Read the matching category file from this index instead of loading all tools at once.