Skip to content
This repository was archived by the owner on May 21, 2026. It is now read-only.

Commit 87b6317

Browse files
committed
fix: resolve linting errors and add markdown files to pre-commit hook
- Fix import order in README observability examples - Fix multiple spaces and trailing spaces in README - Fix type import style in README - Add *.md files to lint-staged configuration for pre-commit linting - Auto-fix formatting issues in DEVELOPMENT.md
1 parent d88df37 commit 87b6317

3 files changed

Lines changed: 14 additions & 7 deletions

File tree

DEVELOPMENT.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,13 @@ We use GitHub Actions to automate our release process, connecting GitHub Release
7777
```
7878

7979
This will:
80+
8081
- Update the version in package.json
8182
- Create a git tag
8283
- Push the changes and tag to GitHub
8384

8485
2. **Create GitHub Release**:
86+
8587
- Go to GitHub repository → "Releases" → "Draft a new release"
8688
- Choose the tag that was just created
8789
- Fill in release notes detailing what's new, fixes, and any breaking changes
@@ -90,6 +92,7 @@ We use GitHub Actions to automate our release process, connecting GitHub Release
9092
3. **Automated Publishing**:
9193

9294
The GitHub Action will automatically:
95+
9396
- Verify the package version matches the GitHub tag
9497
- Run linting and build checks
9598
- Generate a changelog from commits since the last release
@@ -103,10 +106,12 @@ We use GitHub Actions to automate our release process, connecting GitHub Release
103106
To set up automated publishing:
104107

105108
1. Generate an NPM access token:
109+
106110
- Go to npmjs.com → User Settings → Access Tokens
107111
- Create a new token with "Automation" type and publish permissions
108112

109113
2. Add the token to GitHub repository secrets:
114+
110115
- Go to your GitHub repository → Settings → Secrets → Actions
111116
- Add a new secret named `NPM_TOKEN` with the value of your NPM token
112117

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -328,8 +328,8 @@ LANGFUSE_HOST=https://cloud.langfuse.com # or your self-hosted instance
328328
#### 3. Basic Usage
329329

330330
```ts
331-
import { MCPAgent, MCPClient, ObservabilityManager } from 'mcp-use'
332331
import { ChatOpenAI } from '@langchain/openai'
332+
import { MCPAgent, MCPClient, ObservabilityManager } from 'mcp-use'
333333

334334
const client = new MCPClient({
335335
mcpServers: {
@@ -344,7 +344,7 @@ const agent = new MCPAgent({
344344
llm,
345345
client,
346346
maxSteps: 10,
347-
verbose: true // Enable verbose logging for better observability
347+
verbose: true // Enable verbose logging for better observability
348348
})
349349

350350
// Initialize to set up observability callbacks
@@ -483,17 +483,15 @@ Or programmatically:
483483
const agent = new MCPAgent({
484484
llm,
485485
client,
486-
callbacks: [] // No callbacks = no observability
486+
callbacks: [] // No callbacks = no observability
487487
})
488488
```
489489

490490
### Available Observability Exports
491491

492492
```ts
493-
import {
494-
ObservabilityManager,
495-
type ObservabilityConfig
496-
} from 'mcp-use'
493+
import type { ObservabilityConfig } from 'mcp-use'
494+
import { ObservabilityManager } from 'mcp-use'
497495

498496
// Use ObservabilityManager directly for custom setups
499497
const manager = new ObservabilityManager({

package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,10 @@
122122
"*.{js,ts}": [
123123
"eslint --fix",
124124
"eslint"
125+
],
126+
"*.md": [
127+
"eslint --fix",
128+
"eslint"
125129
]
126130
}
127131
}

0 commit comments

Comments
 (0)