MCP Status Invest

🚀 Status Invest - MCP Server

This project is part of the Model Context Protocol (MCP) ecosystem and provides tools to interact with external APIs and domain-specific models. It demonstrates how to build an MCP server with external API integration and data validation.

An integration enabling MCP tools to query stock market data, such as stock prices, indicators, and payment dates, using the Status Invest API. Link

🚀 Quick Start

This Status Invest - MCP Server offers seamless interaction with the Status Invest API to retrieve stock market data. Below are the steps to get you started.

✨ Features

• get-acoes: Retrieve basic stock information.
• get-indicadores: Fetch detailed stock indicator information.
• get-acoes-datas-pagamento: Obtain stock payment dates.
• Input validation using Zod.
• Integration with the Status Invest API using fetch (infrastructure layer).

🏗️ Architecture

This project follows a layered architecture inspired by the Domain-Driven Design (DDD) pattern:

Domain (src/domain)

Defines interfaces and types representing data structures (e.g., StatusInvest).

Infrastructure (src/infrastructure)

Implements external services, such as StatusInvestApiService, responsible for making HTTP requests to the Status Invest API.

Application Layer (src/application)

Contains business logic, processing and formatting data from the infrastructure in StatusInvestService.

Interface (src/interface)

Includes controllers (StatusInvestToolsController) for registering tools in the MCP server, defining validation schemas, and returning results.

Entry Point (src/main.ts)

Initializes the McpServer, configures the transport (StdioServerTransport), instantiates services and controllers, and starts listening on standard input/output.

The project's file structure is as follows:

src/
├── domain/
│   └── models/           # Domain interfaces
├── infrastructure/
│   └── services/         # External API implementation (Status Invest)
├── application/
│   └── services/         # Business logic and data formatting
├── interface/
│   └── controllers/      # MCP tool registration and validation
└── main.ts               # Server entry point
build/                    # Compiled JavaScript code
.vscode/                  # Contains mcp.json file, MCP server configuration

📦 Installation

git clone git@github.com:newerton/mcp-status-invest.git
cd mcp-status-invest
npm install
npm run build

💻 MCP Server Configuration in VSCode

1. Open the terminal and run the following command:

   npm install -g npm
   

2. In VSCode, open the "Terminal" and execute the following command:

   npm install -D @types/node typescript jsconfig.json
   

💻 MCP Server Output in VSCode

// Configure the language mode to JavaScript or TypeScript

🤝 Contribution

Forks and pull requests are welcome! Please read the contribution guidelines before submitting.

📄 License

This project is licensed under the MIT License.