Files
ai-agent-harness/sources/project-types/shared-service.md

1.2 KiB

Shared Service Project Rules

  • Treat APIs, message formats, callback behavior, identifiers, error responses, and operational defaults as contracts used by multiple consumers.
  • Prefer backward-compatible API and schema evolution.
  • Identify all externally visible side effects before changing a request flow.
  • Design retryable operations to be idempotent where duplicate execution could send multiple notifications, create duplicate records, or generate inconsistent results.
  • Define explicit timeout, retry, and failure behavior for external dependencies.
  • Do not send real email, SMS, notifications, callbacks, or business requests during development or validation.
  • Use mocks, fakes, test recipients, or disposable local integrations only when their safety is verified.
  • Do not expose credentials, message contents, personal data, shortened target URLs, or authentication material in logs.
  • Preserve authentication, authorization, rate limits, validation, and abuse controls when modifying endpoints.
  • Review database and rollout compatibility before changing persisted data or shared service behavior.
  • Include consumer impact and rollback considerations in the completion report.