Skip to content

Commit df67b35

Browse files
docs(core): readme update
readme update readme
1 parent 1b32e50 commit df67b35

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ This extension provides a plug-and-play integration between LoopBack4 applicatio
2929

3030
Its purpose is to enable LoopBack APIs, services, and business logic to be exposed as MCP Tools, allowing external MCP clients (such as LLMs, agents, or MCP-compatible apps) to discover and execute server-defined operations.
3131

32+
At present, MCP tool exposure is limited to GET-style endpoints. Support for additional HTTP methods is planned for future iterations.
33+
3234
### Key Features
3335

3436
- Automatic MCP Tool Discovery :-
@@ -78,6 +80,7 @@ All MCP tool methods must use LoopBack `@param` decorators to define their input
7880
name: z.string(),
7981
},
8082
})
83+
@get('/create-user')
8184
async createUser(
8285
@param.query.string('email') email: string,
8386
@param.query.string('name') name: string,
@@ -127,9 +130,9 @@ Step 4: Use in decorator:
127130

128131
```ts
129132
@mcpTool({
130-
name: 'my-tool',
131-
description: 'my-description'
132-
preHookBinding: McpHookBindings.MY_HOOK,
133-
postHookBinding: 'hooks.mcp.myOtherHook' // or string binding key
133+
name: 'my-tool',
134+
description: 'my-description'
135+
preHook: {binding: McpHookBindings.MY_HOOK},
136+
postHook: {binding: 'hooks.mcp.myOtherHook'} // or string binding key
134137
})
135138
```

0 commit comments

Comments
 (0)