MCP REST Client

🚀 MCP Client

This is a client project based on the Model Context Protocol (MCP), aiming to facilitate advanced interactions with AI models and services.

🚀 Quick Start

Prerequisites

• Node.js (version 16 or higher)
• pnpm (package manager)

📦 Installation

1. Clone the repository:

git clone https://github.com/your-username/mcp-client.git
cd mcp-client

2. Install dependencies:

pnpm install

Configuration

1. Copy mcp_config.json.example to mcp_config.json.
2. Modify the configuration file with your own server and tool settings.

💻 Usage Examples

Basic Usage

1. Run the client:

pnpm start

2. When you run the client, all your servers will be automatically registered.

3. You can use the list-tools API to list all available tools for a specific server:

curl --location 'http://localhost:3000/list-tools/{serverName}'

4. You can use the call-tool API to call a specific tool:

curl --location 'http://localhost:3000/call-tool' \
--header 'Content-Type: application/json' \
--data '{
    "serverName": "server_name",
    "toolName": "tool_name",
    "args": {
        // Parameters must match the inputSchema from the list-tools response.
        // Required fields must be included.
        // Optional fields can be omitted.
        // Example based on the above schema:
        // "issue_key": "PROJ-123"  // Required
        // "expand": "..."          // Optional
    }
}'

Cursor Rules

All tool calls are recorded in the .cursorrules file.

⚠️ Important Note

• You must copy CURSORRULES to your own repository and edit it according to your needs.
• You must copy "mcp_config.json" to your own repository and edit it according to your needs.
• You must use a COMPOSER with a proxy.

🤝 Contribution

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/AmazingFeature).
3. Commit your changes (git commit -m 'Add some AmazingFeature').
4. Push to the branch (git push origin feature/AmazingFeature).
5. Open a pull request.

📄 License

Distributed under the MIT License. See LICENSE for more information.

📞 Contact

Your Name - your_email@example.com

Project Link: https://github.com/your-username/mcp-client