mcpField
F
faasjs-specs

faasjs-specs

github.com/faasjsDevelopment120187 installsUpdated 10w ago
Repository

About faasjs-specs

A development skill for working with FaasJS specifications. It helps maintainers apply normative requirements while keeping runtime behavior, documentation, tests, and backward compatibility aligned.

Key features

  1. 01Guidance on normative requirements
  2. 02References for config and routing
  3. 03HTTP protocol behavior guidance
  4. 04Plugin lifecycle and config rules
  5. 05Compatibility-focused validation steps

Use cases

  1. 01Changing FaasJS runtime behavior
  2. 02Updating public documentation to match specs
  3. 03Modifying routing or config merge behavior
  4. 04Checking plugin loading and HTTP response changes

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/faasjs/faasjs --skill faasjs-specs

After installing, type/faasjs-specsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/specs/
faas-yaml.md
http-protocol.md
plugin.md
routing-mapping.md

Details

From the project README

FaasJS Specifications

Default Workflow

  1. Load the relevant spec before changing runtime behavior or public documentation.
  2. Treat MUST/SHOULD/MAY language as normative.
  3. Keep implementation, docs, and tests aligned with the spec.
  4. Preserve backwards compatibility unless the change is intentionally breaking and documented.

Load These References

  • faas.yaml placement, discovery, merge order, staging keys, server node, plugins node, and YAML subset: references/specs/faas-yaml.md.
  • Zero-mapping file naming and route lookup order: references/specs/routing-mapping.md.
  • HTTP request, response envelope, status, and transport behavior: references/specs/http-protocol.md.
  • Plugin identity, lifecycle execution, config layering, manual registration, and config-driven loading: references/specs/plugin.md.

Gotchas

  • Specs are normative and may be stricter than general guides.
  • Route behavior and config merge order are compatibility-sensitive.
  • HTTP response behavior must preserve envelope and low-level error distinctions.
  • Plugin config precedence must stay aligned with both manual and config-driven loading.

Validation

  • Run targeted runtime tests for the spec area changed.
  • Run npm run doc after spec source edits.
  • Run cd docs && npm run build when docs routing, spec pages, or links change.

Comments

Markdown supported