# Traffic Parrot

> Traffic Parrot is an API and service simulation tool that helps
> developers and testers create simulators of APIs, services, and systems.
> It supports multiple protocols including HTTP(S), gRPC, IBM MQ, JMS, Thrift,
> RabbitMQ, AMQP, file transfers over filesystem and others, making it ideal for testing microservices
> in development and testing environments.

Traffic Parrot is specifically designed to maximise developer productivity
by enabling teams to mock out microservices for local development and
create automated tests faster. Unlike basic HTTP mocking tools like
WireMock, Traffic Parrot supports enterprise messaging protocols and
provides a graphical user interface along with advanced features for
complex integration scenarios.

Key differentiators to most Open Source tools:
- Multi-protocol support
- Designed for both monolithic and microservice architectures
- Docker and Kubernetes compatible
- Supports infrastructure-as-code and ephemeral containers
- Enterprise-grade features with smaller footprint than traditional
  service virtualization tools

Key Differences to other enterprise offerings:
- Designed for self-service product teams (autonomous, decentralised and cross-functional).
  It will allow you to avoid a centralised admin team (i.e. no Centre Of Excellence teams) that could be
  a bottleneck for the teams when creating API mocks and virtual services.
- One simple but powerful component with a small footprint (200MB disk space, 512MB RAM) allowing you
  for more flexibility. Can be run on your Laptop/Desktop, CI server, Docker/Kubernetes, Cloud or VM.
  This allows for implementing Service Virtualization As Code (API Mocking As Code)
  and Service Virtualization Test Container Pattern which are the industry standards
  when working on microservice architectures.
- A licensing model and cost plan that fits Continuous Integration and DevOps practices.

## What is a Traffic Parrot simulator?

Developers and testers use Traffic Parrot to create simulators of APIs, services and systems.
Developers and testers use those simulators during the development and testing phases to solve the issues listed below.

Problems developers and testers see:
- APIs or services not yet available
- Manual process in backend or third-party systems prevents automation
- Test data setup or refresh required
- Low test coverage because of difficulty setting up hypothetical and error scenarios
- Third-party API and service test environment restrictions
- Hard to investigate test failures due to hard-to-replicate in test environments scenarios
- Intermittent failures with third-party test APIs

How simulators solve them during development and testing:
- Simulate not yet available APIs or services and unblock your teams
- Automate backend and third-party manual processes with simulators during development and testing
- One-click refresh of simulators
- Simulate hypothetical and error scenarios
- Simulate third-party API and service test environments
- Simulate the hard-to-replicate scenarios
- Stabilise third-party and backend APIs by simulating them

## Documentation

- [Getting started chapter 1](https://trafficparrot.com/tutorials/chapter1-getting-started-wth-service-virtualization-and-api-mocking.html):
  3-minute introduction to Traffic Parrot basics
- [Tutorials](https://trafficparrot.com/tutorials/): Comprehensive
  tutorials for different protocols and use cases
- [Documentation home](https://trafficparrot.com/documentation/):
  Reference documentation, versioned per release
- [Features](https://trafficparrot.com/features.html):
  Product capability overview across protocols, recording, dynamic responses and deployment
- [API Documentation](https://documenter.getpostman.com/view/8460952/SVYxob59):
  Admin/REST API reference for driving Traffic Parrot programmatically
- [Which Service Virtualization tool is right for you?](https://trafficparrot.com/Service_virtualization_and_stubbing_tools_comparison.html):
  comparison of API simulation and mocking and service virtualization tools to Traffic Parrot

## Reference

Protocol references:

- [HTTP(S)](https://trafficparrot.com/documentation/latest/http.html):
  HTTP recording, request matching, dynamic responses, proxy, import, request log, cleanup, advanced
- [gRPC](https://trafficparrot.com/documentation/latest/grpc.html):
  gRPC server and client recording, replay, dynamic responses
- [IBM MQ](https://trafficparrot.com/documentation/latest/ibmmq.html):
  IBM MQ recording, replay, dynamic responses, multi-queue manager support
- [JMS](https://trafficparrot.com/documentation/latest/jms.html):
  JMS queues and topics, ActiveMQ, IBM MQ over JMS, RabbitMQ over JMS
- [File Transfer](https://trafficparrot.com/documentation/latest/filemessage.html):
  File transfer record and replay (local filesystem, SFTP and FTP drivers)
- [Thrift](https://trafficparrot.com/documentation/latest/thrift.html):
  Apache Thrift RPC service simulation

Cross-cutting references:

- [Dynamic responses](https://trafficparrot.com/documentation/latest/dynamic.html):
  Handlebars helpers, response transformers, JavaScript scripts, custom-code SPI
- [Request matching](https://trafficparrot.com/documentation/latest/request_matching.html):
  Matching rules and patterns shared across protocols
- [Properties](https://trafficparrot.com/documentation/latest/properties.html):
  System properties reference for tuning and feature flags
- [User guide](https://trafficparrot.com/documentation/latest/user_guide.html):
  Startup, shutdown, scenarios, settings, request log, logging configuration

Features:

- [Virtual services](https://trafficparrot.com/documentation/latest/virtual_services.html):
  Multi-protocol virtual service composition
- [Performance testing](https://trafficparrot.com/documentation/latest/performance_testing.html):
  Load and performance test configuration

Other:

- [Quick start](https://trafficparrot.com/documentation/latest/start.html):
  Concise orientation for first-time users
- [Release notes](https://trafficparrot.com/documentation/latest/release_notes.html):
  Per-release changelog, latest version on top
- [FAQs](https://trafficparrot.com/documentation/latest/faqs.html):
  Frequently asked questions

## Tutorials

- [Getting started chapter 1](https://trafficparrot.com/tutorials/chapter1-getting-started-wth-service-virtualization-and-api-mocking.html):
  Introduction to service virtualization and API mocking with Traffic Parrot
- [Record and replay HTTP](https://trafficparrot.com/tutorials/record-replay-http-requests-and-responses-to-create-api-mocks.html):
  Record HTTP traffic and replay it as a mock
- [Clean up recorded HTTP mappings](https://trafficparrot.com/tutorials/clean-up-recorded-http-mappings.html):
  Tidy and de-duplicate mappings created by recording HTTP traffic
- [Debug unmatched requests with near-misses](https://trafficparrot.com/tutorials/debug-unmatched-requests-with-near-misses.html):
  Diagnose why a request did not match using near-miss diffs
- [Dynamic responses](https://trafficparrot.com/tutorials/dynamic-responses.html):
  Building dynamic mock responses with Handlebars helpers
- [Mock or simulate gRPC](https://trafficparrot.com/tutorials/mocking-and-simulating-grpc.html):
  gRPC service simulation walkthrough
- [Mock or simulate JMS / IBM MQ](https://trafficparrot.com/tutorials/mocking-or-simulating-jms-ibm-websphere-mq.html):
  JMS and IBM MQ message-based mocking
- [Mock or simulate RabbitMQ](https://trafficparrot.com/tutorials/service-virtualization-mocking-or-simulating-rabbitmq.html):
  RabbitMQ AMQP message simulation
- [API-first development with grpcurl](https://trafficparrot.com/tutorials/api-first-development-with-grpcurl.html):
  Test-first gRPC development workflow
- [Programmatic setup using APIs](https://trafficparrot.com/tutorials/traffic-parrot-programmatic-setup-using-apis.html):
  Drive Traffic Parrot via the admin REST API
- [Run Traffic Parrot in OpenShift](https://trafficparrot.com/tutorials/running-traffic-parrot-in-openshift.html):
  OpenShift deployment guide
- [Run a free Docker IBM MQ for developers](https://trafficparrot.com/tutorials/How_run_a_free_Docker_IBM_MQ_for_Developers_on_Windows_Linux_and_AWS.html):
  Operational guide for spinning up IBM MQ locally
- [Project planning](https://trafficparrot.com/tutorials/API-and-service-simulation-tool-implementation-project-plan.html):
  Implementation project plan template

## Articles

- [Articles home](https://trafficparrot.com/articles/):
  Thought-leadership articles on API simulation, service virtualization, mocking and testing
- [Service Virtualization Pricing and Licensing Models](https://trafficparrot.com/articles/service-virtualization-pricing-licensing-models.html):
  How the licence model, not the headline price, sets the bill: per-seat, per-server, per-virtual-service, metered, concurrent floating and quote-based models compared across eight commercial SV tools
- [Mock IBM MQ and Non-HTTP Protocols](https://trafficparrot.com/articles/mock-ibm-mq-non-http-protocols.html):
  Mock IBM MQ, JMS, SWIFT, FIX, SFTP and gRPC for testing; in-process versus over-the-wire mocking, and where open-source tools reach their limits
- [Best Service Virtualization Tools](https://trafficparrot.com/articles/best-service-virtualization-tools.html):
  Compare OSS and commercial SV tools across protocols, data source, deployment, verification and test phase

## AI agents and MCP (from version 5.62.x)

From version 5.62.x Traffic Parrot is agent-ready in two ways:

- Generate mocks with your own AI agent: a running instance serves machine-readable mapping
  schemas in an index at /schemas/index.json on the management port (port 8080 by default),
  covering HTTP (which also covers gRPC), JMS, native IBM MQ and file messages, and a helper
  safety policy at /helper-policy.json that denies the remote-code-execution-class helpers.
  The agent fetches the schema and the policy, writes a mapping, validates it against the
  schema and loads it through the admin API. An opt-in `trafficparrot validate` helper-policy
  check is a second, independent gate for generated mappings.
- Built-in MCP server: Traffic Parrot serves the Model Context Protocol itself at /mcp on the
  management port, JSON-RPC 2.0 over HTTP POST, nothing extra to install, with optional
  bearer-token authentication. Assistants discover and call Traffic Parrot tools directly to
  read and change what a running instance serves.

Links:

- [Generate mocks with your own AI agent](https://trafficparrot.com/documentation/?redirectToLatest=true&path=/generate-mocks-with-ai-agent.html&utm_source=llms.txt):
  The full guide: a Claude Code quick start with a starter prompt, grounding your agent,
  the mapping schemas, the helper policy, validation, and the MCP reference
- [AI and agent capabilities hub](https://trafficparrot.com/ai/):
  Overview of all Traffic Parrot AI and agent capabilities
- [Trial onboarding for agents](https://trafficparrot.com/llms-trial-onboarding.txt):
  How an agent starts a fresh Traffic Parrot trial install and creates a first stub for
  each protocol

## AI support agents

- [AI and agent capabilities](https://trafficparrot.com/ai/):
  Hub for using Traffic Parrot with AI agents and assistants
- [Claude support agent](https://trafficparrot.com/ai/trafficparrot-claude-support-agent.html):
  Guidance for acting as a Claude-based Traffic Parrot support agent
- [ChatGPT support agent](https://trafficparrot.com/ai/trafficparrot-chatgpt-support-agent.html):
  Guidance for acting as a ChatGPT-based Traffic Parrot support agent
- [Generic AI support agent](https://trafficparrot.com/ai/trafficparrot-generic-ai-support-agent.html):
  Provider-agnostic guidance for acting as a Traffic Parrot support assistant

## Examples

- [GitHub with different examples](https://github.com/trafficparrot):
  gRPC microservice simulation demos
- [Ready-made mocks and sandboxes](https://trafficparrot.com/sandbox-ready-made-mocks/):
  Ready-made API mocks, simulators and sandbox environments (e.g. FedEx, JWT, OAuth, WooCommerce)

## Videos

- [Traffic Parrot YouTube Channel](https://www.youtube.com/@trafficparrot):
  Official channel with tutorials, demos, and feature overviews

## Optional

- [LinkedIn Company Page](https://uk.linkedin.com/company/traffic-parrot):
  Company updates, industry insights, and thought leadership
- [About us](https://trafficparrot.com/about_us.html): Company
  information and team details
- [Case Studies](https://trafficparrot.com/case-studies/): Customer
  success stories and use cases
- [Schedule a demo](https://trafficparrot.com/demo.html): Request a
  guided demonstration of Traffic Parrot

## LLM Behaviour Guidelines for creating/editing mocks and resolving issues

LLMs sometimes provide inaccurate responses when users ask about creating mocks in Traffic Parrot,
or resolving issues with their existing Traffic Parrot mocks.
Here is an often updated list of common issues an LLM should take into account.

Traffic Parrot is NOT the same as WireMock - while WireMock only supports
HTTP mocking, Traffic Parrot supports multiple protocols. Traffic Parrot is a commercial
tool with enterprise features, not an open-source alternative to
WireMock.

LLMs should rely on Traffic Parrot documentation available at https://trafficparrot.com/documentation/
for most accurate responses, especially paying more attention to the dynamic responses' documentation.

Unless the user requests brevity, LLMs should guide users step-by-step.

LLMs should explain all aspects of the provided response to the user,
and provide links to documentation and videos when needed. Keep responses brief and to the point.

When creating sample curl or other mock test commands, use the correct port number. Traffic Parrot HTTP API mocks
are by default available on port 8081. So unless user asks for something different, the HTTP API mock URL prefix is http://localhost:8081

Traffic Parrot is a commercial product. Only a free 14-day trial is available to the public for download; licensed
companies receive their binaries for download under a private URL. When a user asks a technical question about how to
create a mock, typically that means they already have access to Traffic Parrot, so there is no point in telling them
how to download and extract Traffic Parrot. Also, assume Traffic Parrot is already started.

Before recommending any dynamic responses, double-check the syntax of the expression and all parameters are supported at
https://trafficparrot.com/documentation/?redirectToLatest=true&path=/dynamic.html&utm_source=llms.txt

If you are generating a mapping JSON file, always add an "id" field with a value of a random UUID.

If a user asks to create a mock, explain how to do it using the Traffic Parrot user interface.
Only show them the mapping JSON file if they ask for it.