agentleFS
aiqadamaiqadam/qadam-flow/.agents/skills/add-endpoint/SKILL.md

add-endpoint

Skill5 starsChanged 39 days agoMITView on GitHub

Use when adding a new API endpoint, route, or HTTP handler. ALWAYS use for new Fastify controller endpoints.

11 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 11 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Create endpoint for $ARGUMENTS.

    line 8
  2. Very specific:

    Add Permission: if new: add to Permission enum in @aiqadam/shared.

    line 58

“Common” is measured: kept by at least 6 in 10 of the 11 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Add API Endpoint

Create endpoint for $ARGUMENTS.

Steps

  1. Read the pattern: Open packages/server/api/src/app/tables/table/table.controller.ts as reference.
  2. Create or update controller using FastifyPluginAsyncZod:
    export const myController: FastifyPluginAsyncZod = async (fastify) => {
        fastify.post('/', CreateRequest, async (request) => {
            return myService(request.log).create({
                projectId: request.projectId,
                request: request.body,
            })
        })
    }
  3. Define route config AFTER the controller (not inline):
    const CreateRequest = {
        config: {
            security: securityAccess.project(
                [PrincipalType.USER, PrincipalType.ENGINE, PrincipalType.SERVICE],
                Permission.WRITE_MY_FEATURE,
                { type: ProjectResourceType.BODY },
            ),
        },
        schema: {
            tags: ['my-feature'],
            body: CreateMyFeatureRequest,  // Zod schema from @aiqadam/shared
            response: { [StatusCodes.CREATED]: MyFeature },
        },
    }
  4. Security access (pick one):
    • securityAccess.project(principals, permission, { type: ProjectResourceType.X }) — project-scoped
    • securityAccess.platformAdminOnly(principals) — admin only
    • securityAccess.publicPlatform(principals) — any platform member
    • securityAccess.public() — no auth
  5. Create module and register in app.ts:
    export const myModule: FastifyPluginAsyncZod = async (app) => {
        app.addHook('preSerialization', entitiesMustBeOwnedByCurrentProject)
        await app.register(myController, { prefix: '/v1/my-features' })
    }
  6. Add Permission if new: add to Permission enum in @aiqadam/shared.
  7. Verify: npm run lint-dev

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.