Skip to content

Push to git as Xian Lu 鲜嘉露 #52

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

Merged
lilylilysunshine merged 1 commit into from
Feb 7, 2026
Merged

Push to git as Xian Lu 鲜嘉露 #52

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
36 changes: 36 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,7 @@ Full API details live in the documentation.
- [Examples](#examples)
- [Development](#development)
- [Contributing](#contributing)
- [Business Corporation](#business-corporation)

## Installation

Expand Down Expand Up @@ -376,6 +377,9 @@ Your MCP server starts on `http://localhost:8080` with:

## Core Concepts

<details>
<summary>Click to expand Core Concepts</summary>

### Tools

Callable functions that perform actions (like API endpoints).
Expand Down Expand Up @@ -431,8 +435,13 @@ getStats() {
// Resource URI: "servicename://getStats" (auto-generated)
```

</details>

## CLI Commands

<details>
<summary>Click to expand CLI Commands</summary>

The LeanMCP CLI provides an interactive experience for creating and managing MCP projects.

### `leanmcp create <project-name>`
Expand Down Expand Up @@ -479,8 +488,13 @@ leanmcp add weather

For complete CLI documentation including all commands, options, and advanced usage, see [@leanmcp/cli README](./packages/cli/README.md).

</details>

## Decorators

<details>
<summary>Click to expand Decorators</summary>

### Core Decorators

| Decorator | Purpose | Usage |
Expand Down Expand Up @@ -528,8 +542,13 @@ class UserInput {
}
```

</details>

## Project Structure

<details>
<summary>Click to expand Project Structure</summary>

### Main Entry Point (`main.ts`)

**Simplified API (Recommended):**
Expand Down Expand Up @@ -607,8 +626,13 @@ export class ServiceName {
}
```

</details>

## API Reference

<details>
<summary>Click to expand API Reference</summary>

### `createHTTPServer(options | serverFactory, options?)`

Creates and starts an HTTP server with MCP support.
Expand Down Expand Up @@ -698,8 +722,13 @@ server.registerService(new WeatherService());
server.registerService(new PaymentService());
```

</details>

## Examples

<details>
<summary>Click to expand Examples</summary>

### Complete Weather Service

```typescript
Expand Down Expand Up @@ -908,8 +937,13 @@ await mcpClient.callTool({

See [examples/slack-with-auth](./examples/slack-with-auth) for a complete working example.

</details>

## Development

<details>
<summary>Click to expand Development</summary>

### Setting Up the Monorepo

```bash
Expand Down Expand Up @@ -965,6 +999,8 @@ npm link ../../packages/cli
npm start
```

</details>

## Type Safety Benefits

- **Compile-time validation** - Catch errors before runtime
Expand Down
Loading