Market Sizing MCP Server
Fornece pesquisa de mercado e análise de negócios ao integrar-se com múltiplas fontes de dados econômicos como Alpha Vantage, BLS e o Banco Mundial.
Documentação
Market Sizing MCP Server
Um servidor Model Context Protocol que fornece capacidades de pesquisa de mercado e análise de negócios por meio de 28 ferramentas, 15 prompts de negócios e integração com 8 fontes de dados econômicos.
Visão Geral
Este servidor MCP fornece capacidades abrangentes de pesquisa de mercado, incluindo:
- 28 Ferramentas: Ferramentas de análise de mercado, acesso a dados e inteligência de negócios
- 15 Prompts: Modelos profissionais de análise de negócios para financiamento, estratégia e pesquisa
- Integração de Dados: Alpha Vantage, BLS, Census, FRED, IMF, Nasdaq Data Link, OECD, World Bank
- Padrões Inteligentes: Parâmetros pré-configurados para uso imediato sem configuração
- Múltiplos Transportes: Suporte a STDIO, Streamable HTTP e SSE
Capacidades
Ferramentas de Análise de Mercado
- Cálculos de Mercado Endereçável Total (TAM) e Mercado Endereçável Servível (SAM)
- Estimativa e previsão de tamanho de mercado
- Análise de indústria e inteligência competitiva
- Segmentação de mercado e identificação de oportunidades
- Validação de dados e verificação entre fontes
Prompts de Inteligência de Negócios
- Preparação de pitch de financiamento para startups
- Análise de investimento em private equity
- Estratégia corporativa e entrada no mercado
- Gestão de crises e avaliação de impacto regulatório
- Análise de ESG e sustentabilidade
Acesso a Dados
- Recuperação de dados financeiros e econômicos em tempo real
- Agregação e comparação de dados de múltiplas fontes
- Roteamento inteligente com base no tipo e disponibilidade de dados
- Cache abrangente para otimização de desempenho
Recursos do Protocolo MCP
- Notificações em Tempo Real: 6 tipos de notificações específicas de negócios para inteligência de mercado, saúde das fontes de dados, marcos de cálculo e monitoramento de desempenho
- Múltiplos Transportes: Suporte completo aos protocolos STDIO, HTTP e Server-Sent Events (SSE)
- Acesso a Recursos: Documentação e informações de status disponíveis por meio de recursos MCP
- Descoberta de Ferramentas: Catálogo completo de ferramentas com padrões inteligentes e validação
Instalação
Pré-requisitos
- Node.js 20.x ou posterior
- npm ou yarn
- Chaves de API para fontes de dados (opcional, consulte Configuração)
Configuração Rápida
# Clone repository
git clone https://github.com/your-username/TAM-MCP-Server.git
cd TAM-MCP-Server
# Install dependencies
npm install
# Configure environment
cp .env.example .env
# Edit .env with your API keys
# Build and start (HTTP - recommended)
npm run build
npm run start:http
Configuração de Desenvolvimento
# Use development script
chmod +x scripts/dev-setup.sh
./scripts/dev-setup.sh
# Or manual setup
npm install
npm run build
npm run start # HTTP server
npm run start:stdio # STDIO transport
Implantação com Docker
# Build image
docker build -t tam-mcp-server .
# Run container with environment file
docker run -p 3000:3000 --env-file .env tam-mcp-server
# Or run with individual environment variables
docker run -p 3000:3000 \
-e ALPHA_VANTAGE_API_KEY=your_key_here \
-e FRED_API_KEY=your_key_here \
-e NODE_ENV=production \
tam-mcp-server
Integração MCP
Transporte HTTP (Recomendado) Para Claude Desktop, adicione à sua configuração:
{
"mcpServers": {
"tam": {
"command": "npm",
"args": ["run", "start:http"],
"cwd": "/path/to/TAM-MCP-Server"
}
}
}
Transporte STDIO (Alternativa)
{
"mcpServers": {
"tam": {
"command": "npm",
"args": ["run", "start:stdio"],
"cwd": "/path/to/TAM-MCP-Server"
}
}
}
Para MCP Inspector:
# HTTP mode
npm run start:http
# STDIO mode
npx @modelcontextprotocol/inspector npm run start:stdio
Uso
Valores Padrão Inteligentes - Início Sem Fricção
Obtenha insights profissionais de mercado instantaneamente - sem necessidade de pesquisa de parâmetros!
Todas as 28 ferramentas incluem valores padrão inteligentes que permitem começar a analisar imediatamente:
// Call any tool with empty parameters - defaults automatically applied
{
"name": "alphaVantage_getCompanyOverview",
"arguments": {} // Server provides: symbol="AAPL" (Apple Inc.)
}
{
"name": "tam_analysis",
"arguments": {} // Server provides: $10B market, 15% growth, 5-year projection
}
Padrões Profissionais Incluem:
- Análise de Ações: AAPL, MSFT, GOOGL (empresas Fortune 500)
- Dados Econômicos: PIB dos EUA, indicadores globais, períodos de 2020-2024
- Códigos de Indústria: Setor de tecnologia, Serviços Profissionais (NAICS 54)
- Cálculos de Mercado: Mercado base de US$ 10B, taxas de crescimento de 15%, projeções de 5 anos
Perfeito para:
- Usuários iniciantes que obtêm resultados imediatos sem pesquisa de parâmetros
- Ambientes de demonstração que exibem capacidades profissionais de análise de mercado
- Prototipagem rápida com dados e cenários de negócios realistas
Uso Básico de Ferramentas
// Market analysis with defaults
{
"name": "tam_analysis",
"arguments": {}
}
// Company overview with default symbol (AAPL)
{
"name": "alphaVantage_getCompanyOverview",
"arguments": {}
}
// Custom parameters
{
"name": "market_size",
"arguments": {
"industryId": "technology",
"region": "north-america"
}
}
Prompts de Análise de Negócios
Acesse modelos profissionais por meio da interface de prompts:
// List available prompts
{
"method": "prompts/list"
}
// Get startup funding prompt
{
"method": "prompts/get",
"params": {
"name": "startup_funding_pitch",
"arguments": {
"company_name": "TechCorp",
"industry": "SaaS"
}
}
}
Ferramentas MCP - Sistema de Arquitetura em Três Camadas
O TAM MCP Server fornece 28 ferramentas MCP totais organizadas em três camadas complementares:
Camada 1: Ferramentas de Acesso Direto a Dados (13 ferramentas)
Propósito: Acesso bruto a fontes de dados externas Usuários-alvo: Desenvolvedores, engenheiros de dados, construtores de análises personalizadas
alphaVantage_getCompanyOverview: Obtenha visão geral detalhada da empresa e dados financeirosalphaVantage_searchSymbols: Pesquise símbolos de ações e nomes de empresasbls_getSeriesData: Recupere dados de emprego do Bureau of Labor Statisticscensus_fetchIndustryData: Acesse estatísticas da indústria do U.S. Census Bureaucensus_fetchMarketSize: Obtenha dados de tamanho de mercado de pesquisas do Censusfred_getSeriesObservations: Busque séries de dados econômicos do Federal Reserveimf_getDataset: Acesse conjuntos de dados do Fundo Monetário Internacionalimf_getLatestObservation: Obtenha as observações econômicas mais recentes do IMFnasdaq_getDatasetTimeSeries: Recupere séries temporais do Nasdaq Data Linknasdaq_getLatestDatasetValue: Obtenha os valores mais recentes de conjuntos de dados Nasdaqoecd_getDataset: Acesse conjuntos de dados estatísticos da OECDoecd_getLatestObservation: Obtenha as observações econômicas mais recentes da OECDworldBank_getIndicatorData: Busque indicadores de desenvolvimento do World Bank
Camada 2: Ferramentas Básicas de Mercado (4 ferramentas)
Propósito: Capacidades fundamentais de análise de mercado Usuários-alvo: Analistas de negócios iniciando com pesquisa de mercado básica
industry_search: Recuperação básica de dados da indústria de múltiplas fontestam_calculator: Cálculos básicos de Mercado Endereçável Totalmarket_size_calculator: Estimativa básica de tamanho de mercado com explicações de metodologiacompany_financials_retriever: Recuperação básica de dados financeiros de empresas
Camada 3: Ferramentas de Análise de Negócios (11 ferramentas)
Propósito: Inteligência de mercado avançada e análise de negócios abrangente Usuários-alvo: Analistas seniores, pesquisadores de mercado, equipes de investimento
industry_analysis: Análise aprimorada da indústria com múltiplas fontes e classificação inteligenteindustry_data: Inteligência detalhada da indústria com tendências, ESG e principais playersmarket_size: Estimativa e análise avançada de tamanho de mercado com pontuação de confiançatam_analysis: Cálculos avançados de Mercado Endereçável Total com projeções de cenáriossam_calculator: Mercado Endereçável Servível com análise de restriçõesmarket_segments: Análise hierárquica de segmentação de mercadomarket_forecasting: Previsão de séries temporais com análise de cenáriosmarket_comparison: Análise comparativa e classificações de múltiplos mercadosdata_validation: Validação e pontuação de qualidade de dados entre fontesmarket_opportunities: Identificação de lacunas de mercado e oportunidades de crescimentogeneric_data_query: Acesso direto a qualquer serviço e método de fonte de dados
Fontes de Dados
O servidor integra-se com 8 fontes de dados:
- Alpha Vantage: Dados financeiros de empresas, dados de ações
- BLS: Estatísticas de emprego e trabalho
- Census: Dados de indústria e demográficos
- FRED: Dados econômicos do Federal Reserve
- IMF: Dados econômicos internacionais
- Nasdaq Data Link: Conjuntos de dados financeiros
- OECD: Estatísticas internacionais
- World Bank: Indicadores de desenvolvimento
Métodos de Transporte
Servidor HTTP (Recomendado)
npm run start:http
# Server available at http://localhost:3000
Transporte STDIO
npm run start:stdio
Server-Sent Events
npm run start:sse
Configuração
Variáveis de Ambiente
Copie .env.example para .env e configure conforme necessário:
# Server Configuration
PORT=3000
NODE_ENV=development
LOG_LEVEL=info
# API Keys (Optional - tools work without keys but with limited data)
ALPHA_VANTAGE_API_KEY=your_key_here
CENSUS_API_KEY=your_key_here
FRED_API_KEY=your_key_here
NASDAQ_DATA_LINK_API_KEY=your_key_here
BLS_API_KEY=your_key_here
# Cache Configuration (Optional)
CACHE_TTL_DEFAULT_MS=86400000
CACHE_TTL_ALPHA_VANTAGE_MS=86400000
CACHE_TTL_FRED_MS=86400000
Configuração de Fontes de Dados
Chaves Necessárias:
- Alpha Vantage: O nível gratuito fornece 25 solicitações/dia
- Census Bureau: Acesso gratuito à API
- FRED: Acesso gratuito à API
- Nasdaq Data Link: Nível gratuito disponível
Sem Chave Necessária:
- World Bank, OECD, IMF (APIs públicas)
- BLS (chave opcional para limites mais altos)
Padrões de Ferramentas
Todas as ferramentas incluem padrões profissionais. Consulte o Guia de Valores Padrão para listas completas de parâmetros.
Exemplos de Padrões:
- Símbolos de ações: AAPL, MSFT, GOOGL
- Códigos de indústria: NAICS 54 (Serviços Profissionais)
- Tamanhos de mercado: Base de US$ 10B com crescimento de 15%
- Períodos de tempo: 2020-2024
Estratégia de Cache
Cache em Memória (Padrão)
- Baseado em NodeCache com TTLs configuráveis
- Limpeza automática e estatísticas
- Invalidação de cache por fonte
Cache Redis (Produção)
const dataService = new EnhancedDataService({
cache: { type: 'redis' },
apiKeys: { /* your keys */ }
});
Estrutura do Projeto
TAM-MCP-Server/
├── config/ # Configuration files
│ ├── jest.config.json # Jest test configuration
│ ├── vitest.config.ts # Vitest test configuration
│ └── redis.conf # Redis configuration
├── doc/ # Documentation
│ ├── README.md # Documentation hub
│ ├── consumer/ # Consumer documentation
│ │ ├── getting-started.md # Getting started guide
│ │ ├── default-values-guide.md # Default values guide
│ │ ├── mcp-prompts-guide.md # MCP prompts guide
│ │ ├── tools-guide.md # Tools reference
│ │ └── api-reference.md # API documentation
│ ├── contributor/ # Contributor documentation
│ │ ├── contributing.md # Development guidelines
│ │ └── security.md # Security policy
│ ├── reference/ # Reference documentation
│ │ ├── RELEASE-NOTES.md # Version history
│ │ ├── CHANGELOG.md # Technical changes
│ │ └── requirements.md # Technical specifications
│ ├── reports/ # Technical reports and validation
│ │ ├── SEMANTIC-VALIDATION-COMPLETE.md # Validation results
│ │ └── DEFAULT-VALUES-SUMMARY.md # Default values analysis
│ └── archive/ # Historical documents
├── examples/ # Examples and demos
│ ├── README.md # Examples documentation
│ ├── demo-default-values.mjs # Default values demonstration
│ ├── demo-integration.mjs # Integration examples
│ └── TAM-MCP-Server-Postman-Collection.json # API testing
├── scripts/ # Build and development scripts
│ ├── build.sh # Production build script
│ ├── dev-setup.sh # Development environment setup
│ └── dev.sh # Development helper script
├── src/ # Source code
│ ├── index.ts # Main entry point
│ ├── server.ts # Core MCP server
│ ├── http.ts # HTTP transport
│ ├── sse-new.ts # SSE transport
│ ├── stdio-simple.ts # STDIO transport
│ ├── config/ # Configuration modules
│ ├── services/ # Data source services
│ ├── tools/ # MCP tool implementations
│ ├── prompts/ # Business prompt templates
│ ├── notifications/ # Notification system
│ ├── types/ # TypeScript definitions
│ └── utils/ # Utility functions
├── tests/ # Test suite
│ ├── unit/ # Unit tests
│ ├── integration/ # Integration tests
│ ├── e2e/ # End-to-end tests
│ ├── scripts/ # Test and validation scripts
│ │ ├── test-comprehensive.mjs # Comprehensive testing
│ │ ├── test-semantic-validation.mjs # Semantic validation
│ │ └── *.mjs # Additional test utilities
│ ├── fixtures/ # Test data and mock objects
│ ├── utils/ # Test utilities and helpers
│ └── setup.ts # Test configuration
├── logs/ # Application logs
├── dist/ # Compiled JavaScript (built)
├── .env.example # Environment template
├── package.json # Node.js dependencies
├── tsconfig.json # TypeScript configuration
└── README.md # Main documentation
Referência de Ferramentas
Ferramentas de Acesso a Dados MCP (17 ferramentas)
Acesso Direto a Fontes de Dados (13 ferramentas)
| Fonte | Ferramentas | Descrição |
|---|---|---|
| Alpha Vantage | alphaVantage_getCompanyOverview, alphaVantage_searchSymbols | Dados financeiros de empresas e ações |
| BLS | bls_getSeriesData | Dados do Bureau of Labor Statistics |
| Census | census_fetchIndustryData, census_fetchMarketSize | Dados de indústria e demográficos |
| FRED | fred_getSeriesObservations | Dados econômicos do Federal Reserve |
| IMF | imf_getDataset, imf_getLatestObservation | Dados econômicos internacionais |
| Nasdaq | nasdaq_getDatasetTimeSeries, nasdaq_getLatestDatasetValue | Conjuntos de dados financeiros |
| OECD | oecd_getDataset, oecd_getLatestObservation | Estatísticas internacionais |
| World Bank | worldBank_getIndicatorData | Indicadores de desenvolvimento |
Ferramentas Básicas de Mercado (4 ferramentas)
| Ferramenta | Descrição |
|---|---|
industry_search | Pesquisa básica de dados da indústria em fontes |
tam_calculator | Cálculos básicos de Mercado Endereçável Total |
market_size_calculator | Estimativa e cálculos de tamanho de mercado |
company_financials_retriever | Recuperação aprimorada de dados financeiros de empresas |
Ferramentas de Análise de Negócios (11 ferramentas)
| Ferramenta | Descrição |
|---|---|
industry_analysis | Análise aprimorada da indústria com múltiplas fontes |
industry_data | Inteligência detalhada da indústria com tendências e principais players |
market_size | Estimativa avançada de tamanho de mercado com pontuação de confiança |
tam_analysis | Cálculos avançados de Mercado Endereçável Total |
sam_calculator | Análise de Mercado Endereçável Servível |
market_segments | Segmentação hierárquica de mercado |
market_forecasting | Previsão de séries temporais com cenários |
market_comparison | Análise comparativa de múltiplos mercados |
data_validation | Validação de qualidade de dados entre fontes |
market_opportunities | Identificação de lacunas de mercado |
generic_data_query | Acesso direto a serviços de fontes de dados |
Prompts de Negócios (15 modelos)
15 Prompts Profissionais de Análise de Negócios projetados para cenários de negócios do mundo real:
Análise Estratégica de Negócios
- startup_funding_pitch - Apresentações de financiamento Série A-C com análise de TAM/SAM
- private_equity_research - Pacotes de comitê de investimento para negócios de PE
- corporate_strategy_entry - Análise de estratégia de entrada no mercado para Fortune 500
- venture_capital_thesis - Desenvolvimento de tese de investimento de capital de risco
- asset_management_research - Pesquisa de gestão de ativos institucional
Análise de Crise e Especializada
- crisis_management_analysis - Análise de mercado emergencial para resposta a crises
- regulatory_impact_assessment - Análise de impacto de mudanças regulatórias
- international_expansion - Análise de estratégia de entrada em mercados globais
- technology_disruption_analysis - Avaliação de impacto de disrupção tecnológica
- esg_sustainability_analysis - Análise de mercado de ESG e sustentabilidade
Análise Rápida e Orientação
- market_opportunity_scan - Identificação rápida de oportunidades de mercado
- competitive_intelligence - Análise do cenário competitivo
- investment_screening - Triagem de oportunidades de investimento
- tool_guidance - Guia interativo das ferramentas do TAM MCP Server
- best_practices_guide - Melhores práticas para análise de mercado
Projetado para aplicações de IA que atendem analistas de negócios, desenvolvedores e pesquisadores de mercado com inteligência de mercado profunda e ferramentas de acesso a dados.
Desenvolvimento
Testes
O projeto usa uma estrutura de testes abrangente com Vitest como framework de testes principal:
tests/
├── unit/ # Fast, isolated component tests
├── integration/ # Component interaction tests
├── e2e/ # End-to-end workflow tests
├── scripts/ # Integration test scripts
│ ├── test-comprehensive.mjs # Comprehensive testing
│ ├── test-http-streaming.mjs # HTTP streaming transport
│ ├── test-simple-mcp.mjs # Basic MCP functionality
│ └── test-mcp-tool-calls.mjs # Individual tool validation
├── fixtures/ # Test data and mock objects
├── utils/ # Test utilities and helpers
└── setup.ts # Vitest global configuration
Executando Testes
# Run all tests
npm test
# Run by category
npm run test:unit # Fast unit tests
npm run test:integration # Integration tests
npm run test:e2e # End-to-end tests
# Advanced options
npm run test:coverage # With coverage report
npm run test:watch # Watch mode for development
npm run test:ui # Vitest UI mode
npm run test:ci # CI-optimized test run
# Run integration scripts
npm run test:scripts # Comprehensive backend integration
npm run test:scripts:http # HTTP streaming transport
npm run test:scripts:simple # Basic MCP functionality
npm run test:scripts:tools # Individual tool validation
npm run test:scripts:inspector # MCP Inspector compatibility
# Or run directly
node tests/scripts/test-comprehensive.mjs
node tests/scripts/test-http-streaming.mjs
Testes de API com Postman
Importe a coleção abrangente do Postman para testar tanto os endpoints MCP quanto as integrações de API de backend:
Coleção de Testes do Servidor MCP
- Importar Coleção:
examples/TAM-MCP-Server-Postman-Collection.json - Definir Variáveis de Ambiente:
serverUrl: http://localhost:3000sessionId: (definida automaticamente após a inicialização)
- Executar Testes:
- Verificação de saúde e status do servidor
- Inicialização de sessão MCP
- Todas as 28 ferramentas (11 de análise de mercado + 17 de acesso a dados)
- Endpoints de acesso a recursos
- Gerenciamento de sessão e limpeza
Testes com Newman CLI Automatize testes do Postman pela linha de comando:
# Install Newman
npm install -g newman
# Run backend API tests
newman run examples/TAM-MCP-Server-Postman-Collection.json \
-e tests/postman/environments/TAM-MCP-Server-Environment.postman_environment.json \
--reporters cli,json
# Or use npm script
npm run test:postman
Cobertura de Testes
- Nível de Unidade: Funcionalidade individual das ferramentas e lógica de negócio
- Nível de Integração: Conformidade com o protocolo MCP e comportamento do servidor
- Nível de Sistema: Fluxos de trabalho completos através de transportes reais
- Nível de API: Endpoints REST e gerenciamento de sessão
- Desempenho: Monitoramento de tempo de resposta e uso de recursos
Relatórios de cobertura de código são gerados no diretório coverage/.
Estrutura do Projeto
src/
├── index.ts # Main entry point
├── server.ts # MCP server implementation
├── http.ts # HTTP transport
├── sse-new.ts # SSE transport
├── stdio-simple.ts # STDIO transport
├── config/ # Configuration modules
│ └── apiConfig.ts # API endpoint configurations
├── services/ # Data source services
│ ├── dataService.ts # Main data orchestrator
│ ├── cache/ # Caching services
│ │ ├── cacheService.ts # In-memory caching
│ │ └── persistenceService.ts # File persistence
│ └── dataSources/ # Individual data source clients
│ ├── alphaVantageService.ts
│ ├── blsService.ts
│ ├── censusService.ts
│ ├── fredService.ts
│ ├── imfService.ts
│ ├── nasdaqDataService.ts
│ ├── oecdService.ts
│ └── worldBankService.ts
├── tools/ # MCP tool implementations
│ └── market-tools.ts # MarketAnalysisTools class
├── prompts/ # Business prompt templates
├── notifications/ # Notification system
├── types/ # TypeScript definitions
│ ├── index.ts # Core schemas and types
│ ├── dataSources.ts # Data source interfaces
│ └── cache.ts # Cache-related types
└── utils/ # Utility functions
├── dataTransform.ts # Data transformation
├── envHelper.ts # Environment parsing
├── rateLimit.ts # Rate limiting
└── logger.ts # Winston logging
tests/
├── unit/ # Unit tests
├── integration/ # Integration tests
├── e2e/ # End-to-end tests
└── scripts/ # Test automation scripts
Testes de API
Use a coleção Postman incluída:
# Import collection
examples/TAM-MCP-Server-Postman-Collection.json
# Or run with Newman
npm run test:postman
Pilha de Tecnologia
- Linguagem: TypeScript 5.x
- Protocolo: MCP 2025-03-26
- Framework: Express.js 4.x
- Validação: Esquemas Zod
- Testes: Vitest + Postman
- Cache: NodeCache (Redis opcional)
- Registro de Logs: Winston
Solução de Problemas
Problemas Comuns
Serviços aparecendo como desabilitados apesar das chaves de API
- Garanta que o arquivo
.envesteja na raiz do projeto - Verifique se os nomes das variáveis de chave de API correspondem exatamente
- Reinicie o servidor após adicionar as chaves
- Verifique se os logs de inicialização mostram a inicialização do serviço
Problemas de conexão com o MCP Inspector
- Use:
npx @modelcontextprotocol/inspector node dist/stdio-simple.js - Garanta que nenhuma declaração console.log contamine o stdout
- Verifique se o logger Winston usa stderr para saída
Erros de build
- Execute
npm installpara atualizar as dependências - Verifique a versão do Node.js (20.x recomendado)
- Limpe o cache de build:
rm -rf dist && npm run build
Nenhum dado retornado pelas ferramentas
- Verifique o status do serviço nos logs de inicialização
- Verifique se as cotas da API não foram excedidas
- Teste com a ferramenta
generic_data_query - Verifique a conectividade de rede
Obtendo Ajuda
- Verifique Problemas no GitHub
- Revise Notas de Versão
- Envie problemas com logs de erro e detalhes do ambiente
Documentação
Documentação Completa
- Hub de Documentação - Guia completo para toda a documentação do projeto
- Guia de Introdução - Configuração rápida e instruções de primeiro uso
- Guia de Configuração - Configuração do ambiente e gerenciamento de chaves de API
- Referência de Ferramentas - Documentação completa das ferramentas e exemplos de uso
- Guia de Prompts - Modelos de prompts de análise de negócios e cenários
- Referência de API - Documentação completa da API e guias de integração
- Guia de Valores Padrão - Documentação de padrões inteligentes
- Guia de Integração MCP - Recursos MCP e uso do protocolo
Documentação de Desenvolvimento
- Guia de Contribuição - Diretrizes para contribuidores e desenvolvedores
- Política de Segurança - Diretrizes de segurança e relato de vulnerabilidades
- Notas de Versão - Histórico detalhado de alterações e informações de versão
- Changelog - Alterações técnicas e atualizações
Documentação de Testes
- Testes de Integração - Documentação dos scripts de teste de integração
Exemplos e Scripts
- Diretório de Exemplos - Exemplos de API e recursos de integração
- Coleção Postman - Coleção abrangente de testes de API
- Scripts de Desenvolvimento - Scripts de automação de build e configuração
Guias de Implementação
- Guia de Notificações - Sistema de notificações em tempo real
- Visão Geral da Arquitetura - Design do sistema e decisões de arquitetura
Acesso aos Recursos MCP
Toda a documentação também é acessível através do protocolo MCP:
// Discover all available documentation
{
"method": "resources/list",
"params": {}
}
// Read specific documentation
{
"method": "resources/read",
"params": {
"uri": "file:///README.md"
}
}
Recursos de Documentação Disponíveis:
- README.md - Visão geral completa do projeto e documentação de recursos
- Guia de Introdução - Configuração rápida e instruções de primeiro uso
- Guia de Configuração - Configuração do ambiente e gerenciamento de chaves de API
- Referência de Ferramentas - Documentação completa das ferramentas e exemplos de uso
- Guia de Prompts - Modelos de prompts de análise de negócios e cenários
- Referência de API - Documentação completa da API e guias de integração
- Política de Segurança - Diretrizes de segurança e melhores práticas
- Guia de Contribuição - Instruções de desenvolvimento e contribuição
Contribuindo
Contribuições são bem-vindas! Consulte Diretrizes de Contribuição para requisitos.
Licença
Licença MIT - consulte o arquivo LICENSE para detalhes.
Criado por Vaibhav Gupta