Skip to content

Commit b216b1b

Browse files
authored
refactor: add readme files (#19)
* refactor: add readme files * chore: bump version
1 parent 2285cc4 commit b216b1b

File tree

3 files changed

+33
-2
lines changed

3 files changed

+33
-2
lines changed

packages/mcp-auth/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# MCP Auth Node.js SDK
2+
3+
The MCP specification [requires OAuth 2.1 and other RFCs](https://modelcontextprotocol.io/specification/2025-03-26/basic/authorization) for authorization. Instead of implementing all the OAuth 2.1 and OpenID Connect standards yourself, a **production-ready provider** and a set of **libraries and tutorials** can save you a lot of time and effort.
4+
5+
That's where MCP Auth comes in. It includes:
6+
7+
1. An updated OAuth 2.1 and OpenID Connect provider list that meets the MCP requirements.
8+
2. A set of provider-agnostic libraries and tools to help you integrate your MCP server with any compliant provider.
9+
3. Practical tutorials and examples to get you started quickly.
10+
11+
And yes, it can be as simple as a few lines of code:
12+
13+
```ts
14+
const server = new McpServer(/* ... */);
15+
const mcpAuth = new MCPAuth({
16+
server: await fetchServerConfig('<auth-server-url>', { type: 'oidc' }),
17+
});
18+
const app = express();
19+
20+
app.use(mcpAuth.bearerAuth('jwt', { requiredScopes: ['read', 'write'] }));
21+
server.tool('whoami', ({ authInfo }) => {
22+
// Use `authInfo` to access the auth information carried from `req.auth`
23+
});
24+
```
25+
26+
See [the documentation](https://mcp-auth.dev) for the full guide.

packages/mcp-auth/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "mcp-auth",
3-
"version": "0.1.0-beta.0",
3+
"version": "0.1.0-beta.1",
44
"author": "Silverhand Inc. <contact@silverhand.io>",
5-
"description": "Connect your MCP server to any eligible OAuth 2 or OpenID Connect provider",
5+
"description": "Plug and play auth for Model Context Protocol (MCP) servers",
66
"keywords": [
77
"modelcontextprotocol",
88
"mcp",

packages/sample-servers/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# MCP Auth sample servers
2+
3+
This package contains sample servers that demonstrate how to use the MCP Auth Node.js SDK in various scenarios.
4+
5+
See [the documentation](https://mcp-auth.dev/docs/get-started) for the full guide.

0 commit comments

Comments
 (0)