feat: add User-Agent tracking for analytics #14
Conversation
Add clientUserAgent support to identify context-connectors usage in
Augment backend analytics. This enables tracking:
- Which product is calling (context-connectors vs other SDK consumers)
- Which interface is being used (CLI, SDK, MCP, agent)
- For MCP: which client is connecting (prepared for future use)
User-Agent format: context-connectors/{version} via:{interface}
Changes:
- Add buildClientUserAgent() utility in src/core/utils.ts
- Add clientUserAgent option to Indexer, SearchClient, MultiIndexRunner, CLIAgent
- Pass clientUserAgent to DirectContext and AugmentLanguageModel
- Set appropriate interface IDs in CLI commands (cli-search, cli-index, cli-agent, mcp)
- Export ClientInterface and MCPClientInfo types
- Add unit tests for buildClientUserAgent
Requires auggie-sdk >= 0.1.15 (PR #47 merged, awaiting npm release)
Agent-Id: agent-0d00d75b-1ac5-4e85-a310-90e1af295ee3
🤖 Augment PR SummarySummary: Adds a Changes:
🤖 Was this summary useful? React with 👍 or 👎 |
![augment-app-staging[bot]](https://avatars.githubusercontent.com/in/1008152?s=60&v=4){kind=small}
| describe("buildClientUserAgent", () => { | ||
| it("should build basic user agent for cli-search", () => { | ||
| const ua = buildClientUserAgent("cli-search"); | ||
| expect(ua).toMatch(/^context-connectors\/\d+\.\d+\.\d+ via:cli-search$/); |
There was a problem hiding this comment.
These assertions only accept strict x.y.z; if package.json ever uses pre-release/build metadata (e.g. 0.1.3-beta.1) the tests will fail even though buildClientUserAgent() is behaving correctly.
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| function getVersion(): string { | ||
| if (cachedVersion === null) { | ||
| const require = createRequire(import.meta.url); | ||
| const pkg = require('../../package.json'); |
There was a problem hiding this comment.
getVersion() assumes ../../package.json is always readable at runtime; in bundled/packaged environments where package.json isn’t present this will throw and make buildClientUserAgent() crash callers. It may be worth making the version lookup resilient so UA building can’t break normal execution.
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| mcpClientInfo?: MCPClientInfo | ||
| ): string { | ||
| let ua = `context-connectors/${getVersion()} via:${clientInterface}`; | ||
| if (mcpClientInfo) { |
There was a problem hiding this comment.
buildClientUserAgent() appends client:{name}/{version} whenever mcpClientInfo is provided, even if clientInterface isn’t mcp, which could produce misleading analytics strings if misused.
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
Summary
Add
clientUserAgentsupport to identify context-connectors usage in Augment backend analytics. This enables tracking:User-Agent Format
Interface Types
ctxc searchcli-searchcontext-connectors/0.1.3 via:cli-searchsdk-searchcontext-connectors/0.1.3 via:sdk-searchctxc indexcli-indexcontext-connectors/0.1.3 via:cli-indexsdk-indexcontext-connectors/0.1.3 via:sdk-indexctxc mcpmcpcontext-connectors/0.1.3 via:mcpctxc agentcli-agentcontext-connectors/0.1.3 via:cli-agentsdk-agent-providercontext-connectors/0.1.3 via:sdk-agent-providerChanges
buildClientUserAgent()utility insrc/core/utils.tsclientUserAgentoption toIndexer,SearchClient,MultiIndexRunner,CLIAgentclientUserAgenttoDirectContextandAugmentLanguageModelClientInterfaceandMCPClientInfotypesbuildClientUserAgentDependencies
Requires auggie-sdk >= 0.1.15 - PR #47 was merged (https://github.com/augmentcode/auggie-sdk-typescript/pull/47), awaiting npm release.
Once the new auggie-sdk version is published:
package.jsonto require the new versionTesting
buildClientUserAgentaddedPull Request opened by Augment Code with guidance from the PR author