Skip to content

docs(core): readme update #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vaibhavbhalla2505 wants to merge 1 commit into
base: master
Choose a base branch
from
+7 −4
Open

docs(core): readme update #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ This extension provides a plug-and-play integration between LoopBack4 applicatio

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.

At present, MCP tool exposure is limited to GET-style endpoints. Support for additional HTTP methods is planned for future iterations.

### Key Features

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

```ts
@mcpTool({
name: 'my-tool',
description: 'my-description'
preHookBinding: McpHookBindings.MY_HOOK,
postHookBinding: 'hooks.mcp.myOtherHook' // or string binding key
name: 'my-tool',
description: 'my-description'
preHook: {binding: McpHookBindings.MY_HOOK},
postHook: {binding: 'hooks.mcp.myOtherHook'} // or string binding key
})
```