Skip to content

Commit 2f36d91

Browse files
authored
docs: remove stale fork and Smithery references (#69)
## Summary - Fix clone URL pointing to upstream fork (`ttpears` → `paradoxbound`) - Fix repository link in Links section - Remove "NPM Package (Coming Soon)" section - Remove "Remote Deployment (Smithery.ai)" section - Remove Smithery from Features list, data flow diagram, and Links - Remove version label from Project Structure heading - Replace inline Contributing steps with a pointer to CONTRIBUTING.md - Apply same Smithery/fork cleanup to CLAUDE.md ## Test plan - [ ] README renders correctly on GitHub 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Signed-off-by: Paradoxbound <paradoxbound@users.noreply.github.com> Co-authored-by: Paradoxbound <paradoxbound@users.noreply.github.com>
1 parent bc5dbee commit 2f36d91

2 files changed

Lines changed: 8 additions & 27 deletions

File tree

CLAUDE.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ npm start # Run stdio server (node packages/stdio/dist/index.js)
4141
### Data Flow
4242

4343
```
44-
MCP Client (LibreChat/Claude Desktop/Smithery)
44+
MCP Client (LibreChat/Claude Desktop)
4545
4646
Stdio Transport (packages/stdio)
4747
@@ -109,9 +109,6 @@ mcpServers:
109109
BOOKSTACK_TOKEN_SECRET: "..."
110110
```
111111
112-
### Remote (Smithery.ai)
113-
Will be hosted at `bookstack-mcp.webmodule.org` for public use.
114-
115112
## Key Implementation Details
116113
117114
### Tool Registration Pattern
@@ -245,7 +242,7 @@ npm test # runs packages/core tests
245242
3. **Removed complexity** - No SSE, no supergateway, no separate transport layer
246243
4. **Stdio only** - Universal transport works everywhere
247244
5. **Zod schemas** - Type-safe input validation
248-
6. **Simpler deployment** - Just works with LibreChat, Claude Desktop, Smithery
245+
6. **Simpler deployment** - Just works with LibreChat and Claude Desktop
249246

250247
### v2.5.0 Monorepo
251248

@@ -353,7 +350,6 @@ Without these rules, GitHub will allow the merge button regardless of workflow r
353350
## Future Plans
354351

355352
- [ ] Publish to NPM as `bookstack-mcp`
356-
- [ ] Deploy to Smithery.ai at `bookstack-mcp.webmodule.org`
357353
- [ ] Add streamable-http transport for remote hosting
358354
- [ ] Support for BookStack webhooks
359355
- [ ] Caching layer for frequently accessed content

README.md

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ A modern Model Context Protocol (MCP) server for BookStack, providing AI assista
77
- **Modern MCP Implementation** - Uses latest `McpServer` with `registerTool()` API
88
- **Full BookStack API Integration** - Search, read, create, and update content
99
- **Embedded URLs** - All responses include clickable links to BookStack pages
10-
- **Multiple Deployment Options** - Local (stdio), LibreChat, or hosted (Smithery.ai)
10+
- **Multiple Deployment Options** - Docker, stdio, or LibreChat
1111
- **Comprehensive Tools** - 45 tools for BookStack operations
1212
- **Type-Safe** - Full TypeScript with Zod schemas
1313
- **Security** - Write operations disabled by default
@@ -24,7 +24,7 @@ A modern Model Context Protocol (MCP) server for BookStack, providing AI assista
2424

2525
```bash
2626
# Clone repository
27-
git clone https://github.com/ttpears/bookstack-mcp.git
27+
git clone https://github.com/paradoxbound/bookstack-mcp.git
2828
cd bookstack-mcp
2929

3030
# Install dependencies
@@ -109,12 +109,6 @@ mcpServers:
109109
BOOKSTACK_TOKEN_SECRET: "your-token-secret"
110110
```
111111
112-
### NPM Package (Coming Soon)
113-
114-
```bash
115-
npx bookstack-mcp
116-
```
117-
118112
### Docker
119113
120114
```bash
@@ -142,10 +136,6 @@ docker run --rm \
142136
ghcr.io/paradoxbound/bookstack-mcp:latest
143137
```
144138

145-
### Remote Deployment (Smithery.ai)
146-
147-
Coming soon: `bookstack-mcp.webmodule.org`
148-
149139
## Available Tools
150140

151141
### Read Operations (Always Available)
@@ -245,7 +235,7 @@ TEST_BOOKSTACK_TOKEN_SECRET=your-test-token-secret
245235

246236
Tests are self-seeding: they create all required data on the instance and clean up afterward. The test instance can start empty. Tests skip gracefully when credentials are not configured.
247237

248-
## Project Structure (v2.5.0 monorepo)
238+
## Project Structure
249239

250240
```
251241
packages/
@@ -308,7 +298,7 @@ Check logs for error messages:
308298
### Data flow
309299

310300
```
311-
MCP Client (Claude Desktop / LibreChat / Smithery)
301+
MCP Client (Claude Desktop / LibreChat)
312302
│ stdio: tool list request / tool call
313303
314304
packages/stdio — McpServer
@@ -347,20 +337,15 @@ Dependencies are declared in `packages/core/package.json` and `packages/stdio/pa
347337

348338
## Contributing
349339

350-
1. Fork the repository
351-
2. Create a feature branch
352-
3. Make your changes
353-
4. Test with LibreChat and Claude Desktop
354-
5. Submit a pull request
340+
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on making changes, running tests, and the DCO sign-off requirement.
355341

356342
## License
357343

358344
MIT License - see LICENSE file for details
359345

360346
## Links
361347

362-
- **Repository**: https://github.com/ttpears/bookstack-mcp
348+
- **Repository**: https://github.com/paradoxbound/bookstack-mcp
363349
- **BookStack**: https://www.bookstackapp.com
364350
- **MCP**: https://modelcontextprotocol.io
365351
- **LibreChat**: https://www.librechat.ai
366-
- **Smithery**: https://smithery.ai

0 commit comments

Comments
 (0)