mcp-client-ref

mcp-client-ref

By ananis25 GitHub

TUI to test model context protocol servers

Overview

what is mcp-client-ref?

The mcp-client-ref is a terminal-based client designed to test Model Context Protocol (MCP) servers, utilizing the Textual TUI library for a user-friendly interface.

how to use mcp-client-ref?

To use the mcp-client-ref, install the necessary dependencies and run the client script with the path to the MCP servers configuration file as an argument. Use the command: uv run scripts/client.py <mcp_servers_config_path>.

key features of mcp-client-ref?

  • Terminal-based user interface for testing MCP servers.
  • Ability to connect to multiple MCP servers defined in a JSON configuration file.
  • Debugging capabilities through an inspector screen.

use cases of mcp-client-ref?

  1. Testing and debugging MCP servers in a terminal environment.
  2. Connecting to different models by configuring the client code.
  3. Inspecting server responses and performance.

FAQ from mcp-client-ref?

  • What is the MCP servers config file?

The MCP servers config file is a JSON file that lists the MCP servers the client connects to, following the format used by the Claude Desktop app.

  • Can I use different models with this client?

Yes! The client uses the Claude Haiku model by default, but you can configure it to use different models in the client code.

  • Is there any specific environment setup required?

Yes, you need to keep the ANTHROPIC_API_KEY in the .env file to connect to the LLM APIs.

Content

mcp-client-ref

A model context protocol client that runs in the terminal. Thanks to the Textual TUI library.

Installation

To run the client, install the dependencies and run scripts/client.py. Pass the path to the MCP servers config file as an argument.

uv sync
uv run scripts/client.py <mcp_servers_config_path>
  • The MCP servers config file is a JSON file that lists the MCP servers you want the client to connect to. It follows the format used by the Claude Desktop app.
  • The client uses the Claude Haiku model by default, so you'll need to keep the ANTHROPIC_API_KEY in the .env file. It uses the magentic library to connect to the LLM APIs; you can configure a different model to use in the client code.

MCP server inspector

You can debug/test the servers by opening up the inspector screen using the command palette in the app.

No tools information available.
No content found.