使用说明
mcp ts
TypeScript模型上下文协议(MCP)服务器实现,提供从巴西注册中心检索公司信息的工具。
📋 目录
✨ 特性
- MCP 服务器:TypeScript中功能齐全的模型上下文协议服务器实现
- 公司信息工具:使用CNPJ检索详细的公司信息
- 集成于
minhareceita.org实时数据 - 返回全面的公司详细信息,包括注册、合作伙伴和状态
- 集成于
📦 先决条件
- Node.js:v18或更高版本
- npm:v9或更高版本(与Node.js捆绑在一起)
🚀 安装
-
克隆存储库:
git clone <repository_url> cd mcp-ts -
安装依赖项:
npm install
🔨 建筑
将TypeScript代码编译为JavaScript:
npm run build
编译后的文件将在 build/ 目录。
▶️ 跑步
本地执行
直接运行服务器:
node build/server.js
服务器将初始化并加载所有可用工具。
MCP客户端集成
要将此MCP服务器与MCP客户端(例如Claude Desktop)集成,请在MCP设置文件中对其进行配置(通常 claude_desktop_config.json):
{
"mcpServers": {
"mcp-ts": {
"command": "node",
"args": ["/absolute/path/to/mcp-ts/build/server.js"]
}
}
}
备注:替换 /absolute/path/to/mcp-ts/ 使用项目目录的实际绝对路径。
⚙️ 配置
不需要额外的配置文件。服务器使用默认设置运行。
🛠️ 可用工具
getInfoCnpj
使用CNPJ(Cadastro Nacional da Pessoa Jurídica)检索上市公司信息。
参数:
cnpj(string,必填):公司的CNPJ。格式灵活(接受两者12345678901234和12.345.678/0001-34).
输出: 返回一个JSON对象,其中包含:
- 公司名称和法定名称
- 营业地址(街道、号码、城市、州、邮政编码)
- 注册状态和日期
- 业务类型和分类
- 合作伙伴信息
- 其他注册表详细信息
示例:
{
"cnpj": "12.345.678/0001-34",
"company_name": "Example Company",
"status": "Active",
"address": {
"street": "Avenida Paulista",
"city": "São Paulo",
"state": "SP"
}
}
📝 发展
项目结构
mcp-ts/
├── src/
│ ├── server.ts # Main MCP server entry point
│ └── tools/
│ └── infoCnpj.tool.ts # CNPJ information tool implementation
├── build/ # Compiled JavaScript output
├── package.json
├── tsconfig.json
└── README.md
类型安全
该项目采用严格的TypeScript配置构建,以实现最大的类型安全性和可维护性。
