Skip to main content
Glama
vinilana

Spedy NFS-e MCP

by vinilana

Spedy NFS-e MCP

Invokta Action Engine, который предоставляет операции эмиссии и проверки статуса Spedy NFS-e через аутентифицированную конечную точку MCP Streamable HTTP.

Движок содержит три возможности:

  • openapi.emitir-nfse: создаёт и ставит в очередь NFS-e для асинхронной выдачи.

  • openapi.consultar-nfse: читает текущий статус одного NFS-e.

  • openapi.listar-nfse: перечисляет записи NFS-e с фильтрами Spedy и пагинацией.

Все возможности требуют аутентифицированного субъекта. Учётные данные Spedy остаются на стороне сервера и никогда не принимаются как входные данные инструмента MCP.

Первый запуск

npm run check
npm run build
npm run mcp:http

Включённая локальная конфигурация обслуживает MCP по адресу http://127.0.0.1:3400/mcp. Клиенты должны отправлять Authorization: Bearer <MCP_BEARER_TOKEN>.

Зафиксированный .env.example и игнорируемый локальный .env содержат фиктивные значения. Замените MCP_BEARER_TOKEN и SPEDY_API_KEY перед выполнением реальных запросов. Целевой средой коннектора по умолчанию является песочница Spedy; продакшн никогда не выбирается неявно.

Related MCP server: Receita Federal NFS-e: Notas Recebidas MCP

Конфигурация

Variable

Purpose

MCP_BEARER_TOKEN

Защищает конечную точку MCP HTTP; минимум 32 символа.

SPEDY_API_KEY

Отправляется коннектором как серверный X-Api-Key.

SPEDY_BASE_URL

Источник API Spedy, обычно https://sandbox-api.spedy.com.br. Не добавляйте /v1.

INVOKTA_HTTP_HOST

Хост привязки; по умолчанию 127.0.0.1.

INVOKTA_HTTP_PORT

Порт привязки; в локальном примере используется 3400, а адаптер по умолчанию использует 3000, если не задано.

Эмиссия асинхронна. Успешный результат emitir-nfse означает, что Spedy принял и поставил запрос в очередь; используйте consultar-nfse или вебхуки Spedy, чтобы наблюдать за авторизацией или отклонением. Всегда предоставляйте стабильный integrationId, чтобы повторы были идемпотентными.

Карта проекта

  • src/capabilities/ владеет доменными действиями и их контрактами ввода, вывода, доступа и выполнения.

  • src/engine.ts регистрирует стабильные идентификаторы возможностей и предоставляет зависимости, принадлежащие движку.

  • src/direct.ts это наименьший исполняемый смоук-путь.

  • test/engine.test.ts доказывает поведение через публичную границу движка.

  • AGENTS.md фиксирует незыблемую архитектуру проекта и правила поставки.

  • .agents/skills/develop-invokta-project/SKILL.md предоставляет совместимым агентам полный рабочий процесс изменений.

Проверка сгенерированных возможностей

  1. Прочитайте AGENTS.md и сгенерированный навык разработки.

  2. Добавьте падающий тест на уровне движка для нужного доменного результата.

  3. Обновите или замените модуль в src/capabilities/, затем зарегистрируйте его буквальный идентификатор возможности в src/engine.ts.

  4. Сохраняйте прямые и сгенерированные точки входа адаптера на одном экспортируемом движке; не дублируйте обработчик возможности в адаптере.

  5. Запустите npm run check, затем проверьте возможность в devtools перед развёртыванием.

Интерактивная разработка

npm run devtools

Собирает движок и запускает devtools Invokta, обычно на http://localhost:4100/. Откройте URL, выведенный командой, чтобы просматривать возможности, вызывать их из JSON, заполненного схемой, через выбранный путь выполнения, следить за живым трассировкой вызовов, переключать тестовые идентичности и читать отчёт доктора. Изменения исходного кода автоматически пересобирают и перезапускают размещённый движок.

Запустите диагностику devtools только для чтения с помощью:

npm run devtools:doctor

Запуск MCP HTTP

npm run build
npm run mcp:http

Упакуйте сервер и проверьте существующую конечную точку с помощью:

npm run deploy:package
npm run deploy:probe -- --url https://engine.example/mcp

Проверьте доменное значение и правило доступа каждой сгенерированной возможности перед развёртыванием.

Related MCP Connectors

Related MCP Servers