Skip to main content

`pytest --mcp-tools` an opinionated black box tester to call a live MCP server and test it live against its own contracts

Project description

Ci/CD Pipeline PyPI Downloads Monthly Downloads License Documentation

✨ Introduction

🤖 Your MCP server is only as good as what it tells the LLM.

pytest-mcp-tools tests your MCP servers live — checking that schemas are correct, examples actually work and match the schema, and incorrect inputs generate errors. The guiding principle is: good documentation reveals what the user needs to know, whether the user is a human or an LLM or an agent.

This is meant to be run in a staging environment, right before an MCP server is deployed. It can also run in production with the --mcp-tools-production=true set, it will then call only the tools annotated as read-only. However, it does not support authentication currently.

pytest --mcp-tools=http://localhost:8000

🔍 MCP Tools: Discovering endpoints at http://docker-image:8000...
   Checking http://docker-image:8000...
   ✓ Server reachable (status: 404)
   ✓ Found endpoint: /mcp (status: 200)
   ✗ Endpoint /sse not found (status: 404)
   ✗ Endpoint /messages not found (status: 404)
✅ MCP Tools: Discovered endpoints: /mcp

============================= test session starts ==============================
platform linux -- Python 3.11.14, pytest-9.0.2, pluggy-1.6.0 -- /usr/local/bin/python
cachedir: .pytest_cache
rootdir: /app
configfile: pyproject.toml
plugins: mcp-tools-0.1.8, anyio-4.12.1
collecting ... collected 0 items

created 5 tests
✅ MCP tools test created for discovered endpoints: /mcp
docker-image-1  | INFO:     172.28.0.3:39934 - "POST /mcp HTTP/1.1" 200 OK



..::test_mcp_tools[POST /mcp] PASSED                                     [ 11%]
..::test_list_tools_from_basic_server PASSED                             [ 22%]
..::test_tools_have_descriptions PASSED                                  [ 33%]
..::test_tools_have_names PASSED                                         [ 44%]
..::test_tools_have_unique_names PASSED                                  [ 55%]
..::test_generate_spell_card_stream_input_schema_field_descriptions PASSED [ 66%]
..::test_generate_spell_card_stream_input_schema_field_types PASSED      [ 77%]
..::test_generate_spell_card_stream_example_0 PASSED                     [ 88%]
..::test_generate_spell_card_stream_example_1 PASSED                     [100%]

============================== 9 passed in 0.50s ===============================

Reporting Issues

If you tested this on your server, and think that there is an issue, just give me the docker image of your server in the issue, and tell me what you are expecting, what you got. If I can run your image locally, I will be able to test it, and make it work for your use case.

If you don't have a docker hub image, give me a minimal example. I will add a mock server with your minimal example to the testing harness.

Typical Concerns

(I am just writing this down from personal experience working on MCP servers.)

  • If the tests fail because this is is sending fields with null values, simply use Pydantic BaseModels with explicit format to explain that they are not allowed null. The checker validates, as per the MCP standard.

Future Work

I have two plans:

  1. Run it as a container. In this mode, it will also use LLM-as-a-judge for additional tests, to make sure that descriptions and error messages make sense.
  2. I want to add authotization, but I need study what is used commonly, first. Add an issue if you have a request.

Features

Automated Tests

The plugin generates tests to verify:

  • At least one transport is available (HTTP or STDIO)
  • Tools can be listed successfully
  • All tools have description fields

Later versions will include:

  • Call the tools, based on annotations.
  • Check the responses from the tools against outputSchema
  • Token count limiting checks
  • LLM-as-a-Judge checks to validate description quality
  • oAuth and perhaps CORS, as needed. (This is not strictly necessary, because I am imagining that this is going run as a staging test in an environment where all servers are trusted.)

🛠️ Development

The only requirement is 🐳 Docker. (The .devcontainer and tasks.json are prepared assuming a *nix system, but if you know the commands, this will work on Windows, too.)

  1. Clone the repo.
  2. Branch out.
  3. Open in "devcontainer" on VS Code and start developing. Run pytest under tests to test.
  4. Akternatively, if you are a fan of Test-Driven Development like me, you can run the tests without getting on a container. .vscode/tasks.json has the command to do so, but it's also listed here:
docker compose -f tests/docker-compose.yaml up --build --abort-on-container-exit --exit-code-from test

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest_mcp_tools-0.2.1.dev202604241442.tar.gz (31.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file pytest_mcp_tools-0.2.1.dev202604241442.tar.gz.

File metadata

File hashes

Hashes for pytest_mcp_tools-0.2.1.dev202604241442.tar.gz
Algorithm Hash digest
SHA256 d983b08637f8391b5060cd2ee156ca97b909e111317c05d5aadd4e0ecd79cfae
MD5 ff50867b5d73b28b3a3165e7e6897570
BLAKE2b-256 ac8bc986c8ce86433e3230cd02af4d85565ecddc1c6a781ba7fd51cdea669a40

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytest_mcp_tools-0.2.1.dev202604241442.tar.gz:

Publisher: ci.yaml on sinan-ozel/pytest-mcp-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pytest_mcp_tools-0.2.1.dev202604241442-py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_mcp_tools-0.2.1.dev202604241442-py3-none-any.whl
Algorithm Hash digest
SHA256 a9cd04405b5fef178a20da7a0ad2cece532a5ba63588a47f071e536da45238d8
MD5 2c05f8aaf7f4f32d23ee37d7a9f0ca68
BLAKE2b-256 247caa1ca833f385a1bf651cfad262c36f2e2b06a01894ee24327ae647de3b96

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytest_mcp_tools-0.2.1.dev202604241442-py3-none-any.whl:

Publisher: ci.yaml on sinan-ozel/pytest-mcp-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page